Re: Version of the artifacts supported / OpenShift Release
Swagger 2.0 (openapi) is a json schema - that will be released for 1.4 but is retroactively valid for older versions for most endpoints. We have built tooling around the limitations in swagger 1.2 to perform validation an explanation - "oc create --validate=true ..." will check the scheme against your submitted object, and "oc explain pod" / "oc explain pod.spec" will let you explore the various fields. On Sep 20, 2016, at 1:34 AM, Charles Moulliard wrote: Using the Swagger API is certainly interesting but not enough if by example I would like to create a yaml or json file (BuildConfig, DeploymentConfig, ...) A developer could use this doc ( https://docs.openshift.org/latest/rest_api/openshift_v1.html#v1-buildconfig, https://docs.openshift.org/latest/rest_api/openshift_v1.html#v1-buildconfigspec, ...) to learn for the BuildConfig process the spec, fields to be used, what are the mandatory/optional fields, their type, values, ... But we should provide yaml/json reference files, json schemas (see --> http://json-schema.org/) in order to help them to validate that the config file used is compliant to the spec, that they are using the correct values or simply to discover the features supported by example : https://docs.openshift.org/latest/rest_api/openshift_v1.html#v1-buildstrategy Make sense ? On Mon, Sep 19, 2016 at 7:30 PM, Charles Moulliard wrote: > The Swagger GUI is available at this address : https://openshift-server: > 8443/swaggerapi > > https://www.dropbox.com/s/e0jeow7zoj70oyy/Screenshot% > 202016-09-19%2019.30.14.png?dl=0 > > On Mon, Sep 19, 2016 at 7:13 PM, Charles Moulliard > wrote: > >> Is swagger packaged with OpenShift Origin to list the operations, ... ? >> >> On Mon, Sep 19, 2016 at 6:45 PM, Clayton Coleman >> wrote: >> >>> That is generally the swagger docs (1.2 currently) listed here: >>> https://github.com/openshift/origin/tree/master/api/swagger-spec >>> >>> On Mon, Sep 19, 2016 at 8:37 AM, Charles Moulliard >>> wrote: >>> Hi, Is it defined somewhere for each OpenShift Artifacts (Template, DeploymentConfig, Buildconfig, ...), the version of the "syntax" supported according to the OpenShift Server (1.2, 1.3, ...) where it will be executed ? Syntax = Json or YAML Structure supported Example: The DeploymentConfig Template is described here https:// docs.openshift.com/enterprise/latest/dev_guide/deplo yments.html#dev-guide-deployments for the Api Version = 1 - Is Api Version 1 the Api supported by OpenShift Origin 1.x ? OpenShift enterprise 3.x ? - Is it possible to have a Reference Template for each Artifact that we can use top of OpenShift ? Maybe from a Github repo ? Regards, Charles ___ users mailing list users@lists.openshift.redhat.com http://lists.openshift.redhat.com/openshiftmm/listinfo/users >>> >> > ___ users mailing list users@lists.openshift.redhat.com http://lists.openshift.redhat.com/openshiftmm/listinfo/users
Re: Version of the artifacts supported / OpenShift Release
Using the Swagger API is certainly interesting but not enough if by example I would like to create a yaml or json file (BuildConfig, DeploymentConfig, ...) A developer could use this doc ( https://docs.openshift.org/latest/rest_api/openshift_v1.html#v1-buildconfig, https://docs.openshift.org/latest/rest_api/openshift_v1.html#v1-buildconfigspec, ...) to learn for the BuildConfig process the spec, fields to be used, what are the mandatory/optional fields, their type, values, ... But we should provide yaml/json reference files, json schemas (see --> http://json-schema.org/) in order to help them to validate that the config file used is compliant to the spec, that they are using the correct values or simply to discover the features supported by example : https://docs.openshift.org/latest/rest_api/openshift_v1.html#v1-buildstrategy Make sense ? On Mon, Sep 19, 2016 at 7:30 PM, Charles Moulliard wrote: > The Swagger GUI is available at this address : https://openshift-server: > 8443/swaggerapi > > https://www.dropbox.com/s/e0jeow7zoj70oyy/Screenshot% > 202016-09-19%2019.30.14.png?dl=0 > > On Mon, Sep 19, 2016 at 7:13 PM, Charles Moulliard > wrote: > >> Is swagger packaged with OpenShift Origin to list the operations, ... ? >> >> On Mon, Sep 19, 2016 at 6:45 PM, Clayton Coleman >> wrote: >> >>> That is generally the swagger docs (1.2 currently) listed here: >>> https://github.com/openshift/origin/tree/master/api/swagger-spec >>> >>> On Mon, Sep 19, 2016 at 8:37 AM, Charles Moulliard >>> wrote: >>> Hi, Is it defined somewhere for each OpenShift Artifacts (Template, DeploymentConfig, Buildconfig, ...), the version of the "syntax" supported according to the OpenShift Server (1.2, 1.3, ...) where it will be executed ? Syntax = Json or YAML Structure supported Example: The DeploymentConfig Template is described here https:// docs.openshift.com/enterprise/latest/dev_guide/deplo yments.html#dev-guide-deployments for the Api Version = 1 - Is Api Version 1 the Api supported by OpenShift Origin 1.x ? OpenShift enterprise 3.x ? - Is it possible to have a Reference Template for each Artifact that we can use top of OpenShift ? Maybe from a Github repo ? Regards, Charles ___ users mailing list users@lists.openshift.redhat.com http://lists.openshift.redhat.com/openshiftmm/listinfo/users >>> >> > ___ users mailing list users@lists.openshift.redhat.com http://lists.openshift.redhat.com/openshiftmm/listinfo/users
Re: Version of the artifacts supported / OpenShift Release
The Swagger GUI is available at this address : https://openshift-server:8443/swaggerapi https://www.dropbox.com/s/e0jeow7zoj70oyy/Screenshot%202016-09-19%2019.30.14.png?dl=0 On Mon, Sep 19, 2016 at 7:13 PM, Charles Moulliard wrote: > Is swagger packaged with OpenShift Origin to list the operations, ... ? > > On Mon, Sep 19, 2016 at 6:45 PM, Clayton Coleman > wrote: > >> That is generally the swagger docs (1.2 currently) listed here: >> https://github.com/openshift/origin/tree/master/api/swagger-spec >> >> On Mon, Sep 19, 2016 at 8:37 AM, Charles Moulliard >> wrote: >> >>> Hi, >>> >>> Is it defined somewhere for each OpenShift Artifacts (Template, >>> DeploymentConfig, Buildconfig, ...), the version of the "syntax" supported >>> according to the OpenShift Server (1.2, 1.3, ...) where it will be executed >>> ? >>> Syntax = Json or YAML Structure supported >>> >>> Example: The DeploymentConfig Template is described here https:// >>> docs.openshift.com/enterprise/latest/dev_guide/deplo >>> yments.html#dev-guide-deployments for the Api Version = 1 >>> - Is Api Version 1 the Api supported by OpenShift Origin 1.x ? >>> OpenShift enterprise 3.x ? >>> - Is it possible to have a Reference Template for each Artifact that we >>> can use top of OpenShift ? Maybe from a Github repo ? >>> >>> Regards, >>> >>> Charles >>> >>> ___ >>> users mailing list >>> users@lists.openshift.redhat.com >>> http://lists.openshift.redhat.com/openshiftmm/listinfo/users >>> >>> >> > ___ users mailing list users@lists.openshift.redhat.com http://lists.openshift.redhat.com/openshiftmm/listinfo/users
Re: Version of the artifacts supported / OpenShift Release
Is swagger packaged with OpenShift Origin to list the operations, ... ? On Mon, Sep 19, 2016 at 6:45 PM, Clayton Coleman wrote: > That is generally the swagger docs (1.2 currently) listed here: > https://github.com/openshift/origin/tree/master/api/swagger-spec > > On Mon, Sep 19, 2016 at 8:37 AM, Charles Moulliard > wrote: > >> Hi, >> >> Is it defined somewhere for each OpenShift Artifacts (Template, >> DeploymentConfig, Buildconfig, ...), the version of the "syntax" supported >> according to the OpenShift Server (1.2, 1.3, ...) where it will be executed >> ? >> Syntax = Json or YAML Structure supported >> >> Example: The DeploymentConfig Template is described here https:// >> docs.openshift.com/enterprise/latest/dev_guide/deplo >> yments.html#dev-guide-deployments for the Api Version = 1 >> - Is Api Version 1 the Api supported by OpenShift Origin 1.x ? OpenShift >> enterprise 3.x ? >> - Is it possible to have a Reference Template for each Artifact that we >> can use top of OpenShift ? Maybe from a Github repo ? >> >> Regards, >> >> Charles >> >> ___ >> users mailing list >> users@lists.openshift.redhat.com >> http://lists.openshift.redhat.com/openshiftmm/listinfo/users >> >> > ___ users mailing list users@lists.openshift.redhat.com http://lists.openshift.redhat.com/openshiftmm/listinfo/users
Re: Version of the artifacts supported / OpenShift Release
That is generally the swagger docs (1.2 currently) listed here: https://github.com/openshift/origin/tree/master/api/swagger-spec On Mon, Sep 19, 2016 at 8:37 AM, Charles Moulliard wrote: > Hi, > > Is it defined somewhere for each OpenShift Artifacts (Template, > DeploymentConfig, Buildconfig, ...), the version of the "syntax" supported > according to the OpenShift Server (1.2, 1.3, ...) where it will be executed > ? > Syntax = Json or YAML Structure supported > > Example: The DeploymentConfig Template is described here https:// > docs.openshift.com/enterprise/latest/dev_guide/deployments.html#dev-guide- > deployments for the Api Version = 1 > - Is Api Version 1 the Api supported by OpenShift Origin 1.x ? OpenShift > enterprise 3.x ? > - Is it possible to have a Reference Template for each Artifact that we > can use top of OpenShift ? Maybe from a Github repo ? > > Regards, > > Charles > > ___ > users mailing list > users@lists.openshift.redhat.com > http://lists.openshift.redhat.com/openshiftmm/listinfo/users > > ___ users mailing list users@lists.openshift.redhat.com http://lists.openshift.redhat.com/openshiftmm/listinfo/users
