gravitee-io / gravitee-docs Goto Github PK

Gravitee - Documentation

License: Apache License 2.0

Ruby 0.06% HTML 15.00% CSS 83.06% JavaScript 1.39% Dockerfile 0.34% Liquid 0.16%

gravitee-docs's Introduction

Gravitee.io - Documentation

⚠️	THIS DOCUMENTATION APPLIES TO GRAVITEE VERSIONS RELEASED PRIOR TO 4.0. FOR GRAVITEE 4.0 DOCUMENTATION, CLICK HERE.

How to write documentation for Gravitee.io

Our documentation website is generated from AsciiDoc files.
You’ll find these pages under the /pages directory.

Live Preview

We suggest you to use a live preview utility like the one available with jekyll.

First, you need to install:

Ruby: https://www.ruby-lang.org/en
Bundler: run the following command line in your favorite terminal gem install bundler

Then, you will be able to install required dependencies and start the documentation:

# Install dependencies
bundle install

# Build and start the documentation locally
bundle exec jekyll serve --incremental

Go to http://127.0.0.1:4000 to see your modifications.

For contributions guidelines, please refer to CONTRIBUTING.adoc

gravitee-docs's People

Contributors

Stargazers

Watchers

gravitee-docs's Issues

[portal] Explain how to configure top APIs

[swagger] Paths in swagger doc should be an array

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" }}})

Click on "security section"

Result :

https://docs.gravitee.io/apim_installguide_configuration.html#gravitee-standalone-management-security-configuration

Not Found (and informations about your apache webserver )

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"

[portal] fill the "subscribe to an API" page

https://docs.gravitee.io/apim_consumerguide_subscribe.html

html rendering error + type

Last buid => Last build
ToC scrollbar doesn't display last items
display only ToC on Ipad

explain the portal level and the api level
explain what is an homepage
how to use fetchers
who can see unpublished pages ?

Plan

When you create a new plan, you have the possibility to exclude some group of user to subscribe.

Need some real life example

Documentation

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

<icons>font</icons>
<sectanchors>true</sectanchors>

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