Comments (3)
I have this working at the moment:
Something like...
Show issues
GET, POST, DELETE
$ http -j http://localhost:5000/api/v2/issues
HTTP/1.1 200 OK
Cache-Control: max-age=0, private, must-revalidate
Content-Length: 741
Content-Type: application/json
ETag: W/"10136bd40d07a8b98b4d6bdc99e75726"
X-Offset: 5
X-Page: 1
X-Per-Page: 10
X-Request-Id: 4789697e-e307-48ff-92cf-cf4023c10264
X-Runtime: 0.011167
X-Total: 1
X-Total-Pages: 0
[
{
"id": 2,
"identifier": "f9c48b91-2010-4b27-a6a8-2654d964908f",
"permalink": "operational",
"state": "monitoring",
"title": "Email Test",
"updated_at": "2016-11-25T12:02:10.000Z",
"updates": [
{
"identifier": "017ed6395f8e",
"permalink": "degraded-performance",
"state": "investigating",
"text": "We're currently aware of the issue and are investigating the cause. We will provide further updates as we have them.",
"updated_at": "2016-11-25T08:17:23.000Z",
"user": {
"name": "r"
}
},
{
"identifier": "587c5bd11f44",
"permalink": "operational",
"state": "identified",
"text": "fdasfds",
"updated_at": "2016-11-25T08:19:32.000Z",
"user": {
"name": "r"
}
},
{
"identifier": "3df65698afb8",
"state": "monitoring",
"text": "fdafdsafd",
"updated_at": "2016-11-25T12:02:10.000Z",
"user": {
"name": "r"
}
}
]
}
]
Show single Issue
GET, PATCH, DELETE
$ http -j http://localhost:5000/api/v2/issues/f9c48b91-2010-4b27-a6a8-2654d964908f
HTTP/1.1 200 OK
Cache-Control: max-age=0, private, must-revalidate
Content-Length: 739
Content-Type: application/json
ETag: W/"65a6ab72e9df347c2ec73f78f0cfb956"
X-Request-Id: 9438b00a-bc11-4d90-bb6b-c09114954cef
X-Runtime: 0.014978
{
"id": 2,
"identifier": "f9c48b91-2010-4b27-a6a8-2654d964908f",
"permalink": "operational",
"state": "monitoring",
"title": "Email Test",
"updated_at": "2016-11-25T12:02:10.000Z",
"updates": [
{
"identifier": "017ed6395f8e",
"permalink": "degraded-performance",
"state": "investigating",
"text": "We're currently aware of the issue and are investigating the cause. We will provide further updates as we have them.",
"updated_at": "2016-11-25T08:17:23.000Z",
"user": {
"name": "r"
}
},
{
"identifier": "587c5bd11f44",
"permalink": "operational",
"state": "identified",
"text": "fdasfds",
"updated_at": "2016-11-25T08:19:32.000Z",
"user": {
"name": "r"
}
},
{
"identifier": "3df65698afb8",
"state": "monitoring",
"text": "fdafdsafd",
"updated_at": "2016-11-25T12:02:10.000Z",
"user": {
"name": "r"
}
}
]
}
Show issue updates
GET, POST, DELETE
$ http -j http://localhost:5000/api/v2/issues/f9c48b91-2010-4b27-a6a8-2654d964908f/updates
HTTP/1.1 200 OK
Cache-Control: max-age=0, private, must-revalidate
Content-Length: 560
Content-Type: application/json
ETag: W/"baca8fc16ad86f8594b18d72230a1ec3"
X-Offset: 5
X-Page: 1
X-Per-Page: 10
X-Request-Id: d86e8e6b-efcf-490b-8d66-3af032f05a14
X-Runtime: 0.009835
X-Total: 3
X-Total-Pages: 0
[
{
"identifier": "017ed6395f8e",
"permalink": "degraded-performance",
"state": "investigating",
"text": "We're currently aware of the issue and are investigating the cause. We will provide further updates as we have them.",
"updated_at": "2016-11-25T08:17:23.000Z",
"user": {
"name": "r"
}
},
{
"identifier": "587c5bd11f44",
"permalink": "operational",
"state": "identified",
"text": "fdasfds",
"updated_at": "2016-11-25T08:19:32.000Z",
"user": {
"name": "r"
}
},
{
"identifier": "3df65698afb8",
"state": "monitoring",
"text": "fdafdsafd",
"updated_at": "2016-11-25T12:02:10.000Z",
"user": {
"name": "r"
}
}
]
Show specific issue update
GET, PATCH, DELETE
http -j http://localhost:5000/api/v2/issues/f9c48b91-2010-4b27-a6a8-2654d964908f/updates/587c5bd11f44
HTTP/1.1 200 OK
Cache-Control: max-age=0, private, must-revalidate
Content-Length: 153
Content-Type: application/json
ETag: W/"a60f53fd63d91374e0520d826b21b2e5"
X-Request-Id: 23e1d3e2-d1a1-4e8c-b8f2-ed08a87d43d8
X-Runtime: 0.008361
{
"identifier": "587c5bd11f44",
"permalink": "operational",
"state": "identified",
"text": "fdasfds",
"updated_at": "2016-11-25T08:19:32.000Z",
"user": {
"name": "r"
}
}
from moonrope.
I'm afraid I have no intention of rebuilding and/or supporting another API. The API here uses my Moonrope library which provides a self documenting syntax. I believe the current version on here is actually quite outdated so I will get that upgraded so that documentation is generated properly.
The issue here appears to be a lack of documentation rather than any actual technical failing with the API itself.
from moonrope.
Well there are also some inconsistencies that mean double calls to the api.
also the POST to do GET operations which is a touch weird.
just observations. Ill probably contribute a grape wrapper for the system regardless.
thanks for taking the time
from moonrope.
Related Issues (6)
Recommend Projects
-
React
A declarative, efficient, and flexible JavaScript library for building user interfaces.
-
Vue.js
🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
-
Typescript
TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
-
TensorFlow
An Open Source Machine Learning Framework for Everyone
-
Django
The Web framework for perfectionists with deadlines.
-
Laravel
A PHP framework for web artisans
-
D3
Bring data to life with SVG, Canvas and HTML. 📊📈🎉
-
Recommend Topics
-
javascript
JavaScript (JS) is a lightweight interpreted programming language with first-class functions.
-
web
Some thing interesting about web. New door for the world.
-
server
A server is a program made to process requests and deliver data to clients.
-
Machine learning
Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.
-
Visualization
Some thing interesting about visualization, use data art
-
Game
Some thing interesting about game, make everyone happy.
Recommend Org
-
Facebook
We are working to build community through open source technology. NB: members must have two-factor auth.
-
Microsoft
Open source projects and samples from Microsoft.
-
Google
Google ❤️ Open Source for everyone.
-
Alibaba
Alibaba Open Source for everyone
-
D3
Data-Driven Documents codes.
-
Tencent
China tencent open source team.
from moonrope.