gravitee-io / gravitee-docs Goto Github PK
View Code? Open in Web Editor NEWGravitee - Documentation
License: Apache License 2.0
Gravitee - Documentation
License: Apache License 2.0
Add this in <attributes>
:
<icons>font</icons>
<sectanchors>true</sectanchors>
instead of copy/paste block of code or configuration, we should use the include
directive
if the menu is bigger than the page, the menu is not scrollable.
Expand the policies list to reproduce.
Error on link in documentaitons
Page : https://docs.gravitee.io/apim_quickstart_publish.html#create_your_api
Click on "security section"
Result :
Not Found (and informations about your apache webserver )
Add documentation for the dynamic client registration feature (am issue 191)
the css set the width to 700 even if the original image is smaller.
In the swagger doc (1.18.2), for ApiEntity, UpdateApiEntity, PlanEntity, NewPlanEntity, and UpdatePlanEntity, the "paths" field is defined as a Map<String,Path> ("paths": { "type": "object", "additionalProperties":{"$ref":"#/definitions/Path"}}), but the API itself returns a Map<String,Path[]> ("paths": { "type": "object", "additionalProperties": {"type": "array", "items": { "$ref": "#/definitions/Path" }}})
How to get the access token from this: https://github.com/gravitee-io/gravitee-docs/edit/master/pages/am/2.x/quickstart/register-app.adoc#L24
Documentation of gravitee components must be extract from this repo
In a number of places in the swagger doc (https://docs.gravitee.io/apim/api/1.18/swagger.json or https://raw.githubusercontent.com/gravitee-io/gravitee-docs/master/apim/api/1.18/swagger.json) enumerations are documented as all caps, while using the API produces the same enumerations in all lower case.
For example, ApiEntity.visibility is documented as "PUBLIC" or "PRIVATE", but the values retrieved from the API are "public" or "private".
This renders the swagger documentation unusable for code generation.
I am gradually working through the enums where this occurs. So far, I have found:
ApiEntity.visibility
ApiEntity.state
PlanEntity.validation
PlanEntity.security
PlanEntity.type
When you create a new plan, you have the possibility to exclude some group of user to subscribe.
Need some real life example
You can manage access control for pages.
You can either include/exclude groups or role
Example : this page of documentation is only accessible for Application Owner
The documentation is ugly.
A beautiful documentation is engaging.
It could be a good thing if the documentation looks like the website.
here are the commands :
curl -X GET "https://{ES_HOST}/_cat/indices?v"
curl -X POST "https://{ES_HOST}/_reindex" -H 'Content-Type: application/json' -d'
{
"source": {
"index": "gravitee-request-2019.01.22"
},
"dest": {
"index": "tmp_gravitee-request-2019.01.22"
}
}
'
curl -X DELETE "https://{ES_HOST}/gravitee-request-2019.01.22"
curl -X POST "https://{ES_HOST}/_reindex" -H 'Content-Type: application/json' -d'
{
"source": {
"index": "tmp_gravitee-request-2019.01.22"
},
"dest": {
"index": "gravitee-request-2019.01.22"
}
}
'
curl -X PUT "https://{ES_HOST}/gravitee-request-2019.01.22/_mapping/request" -H 'Content-Type: application/json' -d'
{
"properties": {
"@timestamp": {
"type": "date"
},
"api": {
"type": "keyword"
},
"api-key": {
"type": "keyword",
"index": false
},
"api-response-time": {
"type": "integer"
},
"application": {
"type": "keyword"
},
"endpoint": {
"type": "keyword"
},
"gateway": {
"type": "keyword"
},
"local-address": {
"type": "keyword",
"index": false
},
"message": {
"type": "keyword",
"index": false
},
"method": {
"type": "short"
},
"plan": {
"type": "keyword"
},
"proxy-latency": {
"type": "integer",
"index": false
},
"remote-address": {
"type": "ip",
"index": false
},
"geoip": {
"properties": {
"continent_name": {
"type": "keyword",
"index": true
},
"country_iso_code": {
"type": "keyword",
"index": true
},
"region_name": {
"type": "keyword",
"index": true
},
"city_name": {
"type": "keyword",
"index": true
},
"location": {
"type": "geo_point"
}
}
},
"request-content-length": {
"type": "integer",
"index": false
},
"response-content-length": {
"type": "integer",
"index": false
},
"response-time": {
"type": "integer"
},
"status": {
"type": "short"
},
"tenant": {
"type": "keyword"
},
"transaction": {
"type": "keyword"
},
"uri": {
"type": "keyword"
},
"path": {
"type": "keyword"
},
"mapped-path": {
"type": "keyword"
},
"host": {
"type": "keyword"
}
}
}
'
curl -X DELETE "https://{ES_HOST}/tmp_gravitee-request-2019.01.22"
curl -X GET "https://{ES_HOST}/_cat/indices?v"
A declarative, efficient, and flexible JavaScript library for building user interfaces.
๐ Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
An Open Source Machine Learning Framework for Everyone
The Web framework for perfectionists with deadlines.
A PHP framework for web artisans
Bring data to life with SVG, Canvas and HTML. ๐๐๐
JavaScript (JS) is a lightweight interpreted programming language with first-class functions.
Some thing interesting about web. New door for the world.
A server is a program made to process requests and deliver data to clients.
Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.
Some thing interesting about visualization, use data art
Some thing interesting about game, make everyone happy.
We are working to build community through open source technology. NB: members must have two-factor auth.
Open source projects and samples from Microsoft.
Google โค๏ธ Open Source for everyone.
Alibaba Open Source for everyone
Data-Driven Documents codes.
China tencent open source team.