diff --git a/benchmark/build.gradle.kts b/benchmark/build.gradle.kts index 03e41204..fd22b1c7 100644 --- a/benchmark/build.gradle.kts +++ b/benchmark/build.gradle.kts @@ -60,7 +60,7 @@ benchmark { iterationTime = properties["benchmark_iteration_time"]?.takeIfNotBlank()?.toLong() ?: 1L iterationTimeUnit = properties["benchmark_iteration_time_unit"]?.takeIfNotBlank() ?: "s" reportFormat = properties["benchmark_report_format"]?.takeIfNotBlank() ?: "json" - param("objectPath", "$projectDir/data/openapi.json") + param("objectPath", "$projectDir/data/openapi.json", "$projectDir/data/openapi-invalid.json") param("schemaPath", "$projectDir/data/schemas/openapi_schema.json") } } diff --git a/benchmark/data/openapi-invalid.json b/benchmark/data/openapi-invalid.json new file mode 100644 index 00000000..d0dc1503 --- /dev/null +++ b/benchmark/data/openapi-invalid.json @@ -0,0 +1,791 @@ +{ + "info": { + "title": 42, + "x-logo": { + "url": "https://www.ga4gh.org/wp-content/themes/ga4gh-theme/gfx/GA-logo-horizontal-tag-RGB.svg" + }, + "description": "## Executive Summary\nThe Task Execution Service (TES) API is a standardized schema and API for describing and executing batch execution tasks. A task defines a set of input files, a set of containers and commands to run, a set of output files and some other logging and metadata.\n\nTES servers accept task documents and execute them asynchronously on available compute resources. A TES server could be built on top of a traditional HPC queuing system, such as Grid Engine, Slurm or cloud style compute systems such as AWS Batch or Kubernetes.\n## Introduction\nThis document describes the TES API and provides details on the specific endpoints, request formats, and responses. It is intended to provide key information for developers of TES-compatible services as well as clients that will call these TES services. Use cases include:\n\n - Deploying existing workflow engines on new infrastructure. Workflow engines\n such as CWL-Tes and Cromwell have extentions for using TES. This will allow\n a system engineer to deploy them onto a new infrastructure using a job scheduling\n system not previously supported by the engine.\n\n - Developing a custom workflow management system. This API provides a common\n interface to asynchronous batch processing capabilities. A developer can write\n new tools against this interface and expect them to work using a variety of\n backend solutions that all support the same specification.\n\n\n## Standards\nThe TES API specification is written in OpenAPI and embodies a RESTful service philosophy. It uses JSON in requests and responses and standard HTTP/HTTPS for information transport. HTTPS should be used rather than plain HTTP except for testing or internal-only purposes.\n### Authentication and Authorization\nIs is envisaged that most TES API instances will require users to authenticate to use the endpoints. However, the decision if authentication is required should be taken by TES API implementers.\n\nIf authentication is required, we recommend that TES implementations use an OAuth2 bearer token, although they can choose other mechanisms if appropriate.\n\nChecking that a user is authorized to submit TES requests is a responsibility of TES implementations.\n### CORS\nIf TES API implementation is to be used by another website or domain it must implement Cross Origin Resource Sharing (CORS). Please refer to https://w3id.org/ga4gh/product-approval-support/cors for more information about GA4GH’s recommendations and how to implement CORS.\n" + }, + "servers": [ + { + "description": 42 + } + ], + "paths": { + "/service-info": { + "get": { + "tags": [ + 42 + ], + "summary": "GetServiceInfo", + "description": "Provides information about the service, this structure is based on the\nstandardized GA4GH service info structure. In addition, this endpoint\nwill also provide information about customized storage endpoints offered\nby the TES server.", + "operationId": "GetServiceInfo", + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/tesServiceInfo" + } + } + } + } + } + } + }, + "/tasks": { + "get": { + "tags": [ + "TaskService" + ], + "summary": 42, + "description": "List tasks tracked by the TES server. This includes queued, active and completed tasks.\nHow long completed tasks are stored by the system may be dependent on the underlying\nimplementation.", + "operationId": "ListTasks", + "parameters": [ + { + "in": "query", + "description": "OPTIONAL. Filter the list to include tasks where the name matches this prefix.\nIf unspecified, no task name filtering is done.", + "schema": { + "type": "string" + } + }, + { + "name": "page_size", + "description": "Optional number of tasks to return in one page.\nMust be less than 2048. Defaults to 256.", + "schema": { + "type": "integer", + "format": "int64" + } + }, + { + "name": "page_token", + "in": "query", + "description": "OPTIONAL. Page token is used to retrieve the next page of results.\nIf unspecified, returns the first page of results. The value can be found\nin the `next_page_token` field of the last returned result of ListTasks", + "schema": { + "type": "unknown" + } + }, + { + "$ref": "#/components/parameters/view" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/tesListTasksResponse" + } + } + } + } + } + }, + "post": { + "tags": [ + "TaskService" + ], + "summary": "CreateTask", + "description": "Create a new task. The user provides a Task document, which the server\nuses as a basis and adds additional fields.", + "operationId": 42, + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/tesTask" + } + } + }, + "required": true + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/tesCreateTaskResponse" + } + } + } + } + }, + "x-codegen-request-body-name": "body" + } + }, + "/tasks/{id}": { + "get": { + "tags": [ + 42 + ], + "summary": "GetTask", + "description": "Get a single task, based on providing the exact task ID string.", + "operationId": "GetTask", + "parameters": [ + { + "name": "id", + "required": true, + "description": "ID of task to retrieve.", + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/view" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/tesTask" + } + } + } + } + } + } + }, + "/tasks/{id}:cancel": { + "post": { + "tags": [ + "TaskService" + ], + "summary": 42, + "description": "Cancel a task based on providing an exact task ID.", + "operationId": "CancelTask", + "parameters": [ + { + "in": "path", + "description": "ID of task to be canceled.", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/tesCancelTaskResponse" + } + } + } + } + } + } + } + }, + "components": { + "parameters": { + "view": { + "name": "view", + "description": "OPTIONAL. Affects the fields included in the returned Task messages.\n\n`MINIMAL`: Task message will include ONLY the fields:\n- `tesTask.Id`\n- `tesTask.State`\n\n`BASIC`: Task message will include all fields EXCEPT:\n- `tesTask.ExecutorLog.stdout`\n- `tesTask.ExecutorLog.stderr`\n- `tesInput.content`\n- `tesTaskLog.system_logs`\n\n`FULL`: Task message includes all fields.", + "schema": { + "type": "string", + "default": "MINIMAL", + "enum": [ + "MINIMAL", + "BASIC", + "FULL" + ] + } + } + }, + "schemas": { + "tesCancelTaskResponse": { + "type": "unknown", + "description": "CancelTaskResponse describes a response from the CancelTask endpoint." + }, + "tesCreateTaskResponse": { + "required": [ + "id" + ], + "type": 42, + "properties": { + "id": { + "type": "string", + "description": "Task identifier assigned by the server." + } + }, + "description": "CreateTaskResponse describes a response from the CreateTask endpoint. It\nwill include the task ID that can be used to look up the status of the job." + }, + "tesExecutor": { + "required": [ + "command", + "image" + ], + "type": "object", + "properties": { + "image": { + "type": 42, + "example": "ubuntu:20.04", + "description": "Name of the container image. The string will be passed as the image\nargument to the containerization run command. Examples:\n - `ubuntu`\n - `quay.io/aptible/ubuntu`\n - `gcr.io/my-org/my-image`\n - `myregistryhost:5000/fedora/httpd:version1.0`" + }, + "command": { + "type": "array", + "description": "A sequence of program arguments to execute, where the first argument\nis the program to execute (i.e. argv). Example:\n```\n{\n \"command\" : [\"/bin/md5\", \"/data/file1\"]\n}\n```", + "items": { + "type": "string" + }, + "example": [ + "/bin/md5", + "/data/file1" + ] + }, + "workdir": { + "type": "string", + "description": "The working directory that the command will be executed in.\nIf not defined, the system will default to the directory set by\nthe container image.", + "example": "/data/" + }, + "stdin": { + "type": "string", + "description": "Path inside the container to a file which will be piped\nto the executor's stdin. This must be an absolute path. This mechanism\ncould be used in conjunction with the input declaration to process\na data file using a tool that expects STDIN.\n\nFor example, to get the MD5 sum of a file by reading it into the STDIN\n```\n{\n \"command\" : [\"/bin/md5\"],\n \"stdin\" : \"/data/file1\"\n}\n```", + "example": "/data/file1" + }, + "stdout": { + "type": "string", + "description": "Path inside the container to a file where the executor's\nstdout will be written to. Must be an absolute path. Example:\n```\n{\n \"stdout\" : \"/tmp/stdout.log\"\n}\n```", + "example": "/tmp/stdout.log" + }, + "stderr": { + "type": "string", + "description": "Path inside the container to a file where the executor's\nstderr will be written to. Must be an absolute path. Example:\n```\n{\n \"stderr\" : \"/tmp/stderr.log\"\n}\n```", + "example": "/tmp/stderr.log" + }, + "env": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "description": "Enviromental variables to set within the container. Example:\n```\n{\n \"env\" : {\n \"ENV_CONFIG_PATH\" : \"/data/config.file\",\n \"BLASTDB\" : \"/data/GRC38\",\n \"HMMERDB\" : \"/data/hmmer\"\n }\n}\n```", + "example": { + "BLASTDB": "/data/GRC38", + "HMMERDB": "/data/hmmer" + } + } + }, + "description": "Executor describes a command to be executed, and its environment." + }, + "tesExecutorLog": { + "required": [ + "exit_code" + ], + "type": "object", + "properties": { + "start_time": { + "type": "unknown", + "description": "Time the executor started, in RFC 3339 format.", + "example": "2020-10-02T15:00:00.000Z" + }, + "end_time": { + "type": "string", + "description": "Time the executor ended, in RFC 3339 format.", + "example": "2020-10-02T16:00:00.000Z" + }, + "stdout": { + "type": "unknown", + "description": "Stdout content.\n\nThis is meant for convenience. No guarantees are made about the content.\nImplementations may chose different approaches: only the head, only the tail,\na URL reference only, etc.\n\nIn order to capture the full stdout client should set Executor.stdout\nto a container file path, and use Task.outputs to upload that file\nto permanent storage." + }, + "stderr": { + "type": "string", + "description": "Stderr content.\n\nThis is meant for convenience. No guarantees are made about the content.\nImplementations may chose different approaches: only the head, only the tail,\na URL reference only, etc.\n\nIn order to capture the full stderr client should set Executor.stderr\nto a container file path, and use Task.outputs to upload that file\nto permanent storage." + }, + "exit_code": { + "type": "integer", + "description": "Exit code.", + "format": "int32" + } + }, + "description": "ExecutorLog describes logging information related to an Executor." + }, + "tesFileType": { + "type": "string", + "default": "FILE", + "enum": [ + "FILE", + "DIRECTORY" + ] + }, + "tesInput": { + "required": [ + "path", + "type" + ], + "type": "object", + "properties": { + "name": { + "type": "unknown" + }, + "description": { + "type": "string" + }, + "url": { + "type": "string", + "description": "REQUIRED, unless \"content\" is set.\n\nURL in long term storage, for example:\n - s3://my-object-store/file1\n - gs://my-bucket/file2\n - file:///path/to/my/file\n - /path/to/my/file", + "example": "s3://my-object-store/file1" + }, + "path": { + "type": "unknown", + "description": "Path of the file inside the container.\nMust be an absolute path.", + "example": "/data/file1" + }, + "type": { + "$ref": "#/components/schemas/tesFileType" + }, + "content": { + "type": "unknown", + "description": "File content literal.\n\nImplementations should support a minimum of 128 KiB in this field\nand may define their own maximum.\n\nUTF-8 encoded\n\nIf content is not empty, \"url\" must be ignored." + } + }, + "description": 42 + }, + "tesListTasksResponse": { + "required": [ + "tasks" + ], + "type": "object", + "properties": { + "tasks": { + "type": "unknown", + "description": "List of tasks. These tasks will be based on the original submitted\ntask document, but with other fields, such as the job state and\nlogging info, added/changed as the job progresses.", + "items": { + "$ref": "#/components/schemas/tesTask" + } + }, + "next_page_token": { + "type": "string", + "description": "Token used to return the next page of results. This value can be used\nin the `page_token` field of the next ListTasks request." + } + }, + "description": "ListTasksResponse describes a response from the ListTasks endpoint." + }, + "tesOutput": { + "required": [ + "path", + "type", + "url" + ], + "type": "object", + "properties": { + "name": { + "type": "unknown", + "description": "User-provided name of output file" + }, + "description": { + "type": "string", + "description": "Optional users provided description field, can be used for documentation." + }, + "url": { + "type": "unknown", + "description": "URL for the file to be copied by the TES server after the task is complete.\nFor Example:\n - `s3://my-object-store/file1`\n - `gs://my-bucket/file2`\n - `file:///path/to/my/file`" + }, + "path": { + "type": "string", + "description": "Path of the file inside the container.\nMust be an absolute path." + }, + "type": { + "$ref": "#/components/schemas/tesFileType" + } + }, + "description": "Output describes Task output files." + }, + "tesOutputFileLog": { + "required": [ + "path", + "size_bytes", + "url" + ], + "type": "object", + "properties": { + "url": { + "type": "string", + "description": "URL of the file in storage, e.g. s3://bucket/file.txt" + }, + "path": { + "type": "unknown", + "description": "Path of the file inside the container. Must be an absolute path." + }, + "size_bytes": { + "type": "string", + "description": "Size of the file in bytes. Note, this is currently coded as a string\nbecause official JSON doesn't support int64 numbers.", + "format": "int64", + "example": [ + "1024" + ] + } + }, + "description": "OutputFileLog describes a single output file. This describes\nfile details after the task has completed successfully,\nfor logging purposes." + }, + "tesResources": { + "type": "object", + "properties": { + "cpu_cores": { + "type": "unknown", + "description": "Requested number of CPUs", + "format": "int64", + "example": 4 + }, + "preemptible": { + "type": "boolean", + "description": "Define if the task is allowed to run on preemptible compute instances,\nfor example, AWS Spot. This option may have no effect when utilized\non some backends that don't have the concept of preemptible jobs.", + "format": "boolean", + "example": false + }, + "ram_gb": { + "type": "number", + "description": "Requested RAM required in gigabytes (GB)", + "format": "double", + "example": 8 + }, + "disk_gb": { + "type": "number", + "description": "Requested disk size in gigabytes (GB)", + "format": "double", + "example": 40 + }, + "zones": { + "type": "unknown", + "description": "Request that the task be run in these compute zones. How this string\nis utilized will be dependent on the backend system. For example, a\nsystem based on a cluster queueing system may use this string to define\npriorty queue to which the job is assigned.", + "items": { + "type": "string" + }, + "example": "us-west-1" + } + }, + "description": "Resources describes the resources requested by a task." + }, + "tesServiceType": { + "allOf": [ + { + "$ref": "#/components/schemas/ServiceType" + }, + { + "type": "object", + "required": [ + "artifact" + ], + "properties": { + "artifact": { + "type": "unknown", + "enum": [ + "tes" + ], + "example": "tes" + } + } + } + ] + }, + "tesServiceInfo": { + "allOf": [ + { + "$ref": "#/components/schemas/Service" + }, + { + "type": "object", + "properties": { + "storage": { + "type": "array", + "description": "Lists some, but not necessarily all, storage locations supported\nby the service.", + "items": { + "type": "unknown" + }, + "example": [ + "file:///path/to/local/funnel-storage", + "s3://ohsu-compbio-funnel/storage" + ] + }, + "type": { + "$ref": "#/components/schemas/tesServiceType" + } + } + } + ] + }, + "tesState": { + "type": "unknown", + "readOnly": true, + "description": "Task state as defined by the server.\n\n - `UNKNOWN`: The state of the task is unknown. The cause for this status\n message may be dependent on the underlying system. The `UNKNOWN` states\n provides a safe default for messages where this field is missing so\n that a missing field does not accidentally imply that\n the state is QUEUED.\n - `QUEUED`: The task is queued and awaiting resources to begin computing.\n - `INITIALIZING`: The task has been assigned to a worker and is currently preparing to run.\nFor example, the worker may be turning on, downloading input files, etc.\n - `RUNNING`: The task is running. Input files are downloaded and the first Executor\nhas been started.\n - `PAUSED`: The task is paused. The reasons for this would be tied to\n the specific system running the job. An implementation may have the ability\n to pause a task, but this is not required.\n - `COMPLETE`: The task has completed running. Executors have exited without error\nand output files have been successfully uploaded.\n - `EXECUTOR_ERROR`: The task encountered an error in one of the Executor processes. Generally,\nthis means that an Executor exited with a non-zero exit code.\n - `SYSTEM_ERROR`: The task was stopped due to a system error, but not from an Executor,\nfor example an upload failed due to network issues, the worker's ran out\nof disk space, etc.\n - `CANCELED`: The task was canceled by the user.", + "default": "UNKNOWN", + "example": "COMPLETE", + "enum": [ + "UNKNOWN", + "QUEUED", + "INITIALIZING", + "RUNNING", + "PAUSED", + "COMPLETE", + "EXECUTOR_ERROR", + "SYSTEM_ERROR", + "CANCELED" + ] + }, + "tesTask": { + "required": [ + "executors" + ], + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "Task identifier assigned by the server.", + "readOnly": true, + "example": "job-0012345" + }, + "state": { + "$ref": "#/components/schemas/tesState" + }, + "name": { + "type": "unknown", + "description": "User-provided task name." + }, + "description": { + "type": "string", + "description": "Optional user-provided description of task for documentation purposes." + }, + "inputs": { + "type": "unknown", + "description": "Input files that will be used by the task. Inputs will be downloaded\nand mounted into the executor container as defined by the task request\ndocument.", + "items": { + "$ref": "#/components/schemas/tesInput" + }, + "example": [ + { + "url": "s3://my-object-store/file1", + "path": "/data/file1" + } + ] + }, + "outputs": { + "type": "array", + "description": "Output files.\nOutputs will be uploaded from the executor container to long-term storage.", + "items": { + "$ref": "#/components/schemas/tesOutput" + }, + "example": [ + { + "path": "/data/outfile", + "url": "s3://my-object-store/outfile-1", + "type": "FILE" + } + ] + }, + "resources": { + "$ref": "#/components/schemas/tesResources" + }, + "executors": { + "type": "array", + "description": "An array of executors to be run. Each of the executors will run one\nat a time sequentially. Each executor is a different command that\nwill be run, and each can utilize a different docker image. But each of\nthe executors will see the same mapped inputs and volumes that are declared\nin the parent CreateTask message.\n\nExecution stops on the first error.", + "items": { + "$ref": "#/components/schemas/tesExecutor" + } + }, + "volumes": { + "type": "array", + "example": [ + "/vol/A/" + ], + "description": "Volumes are directories which may be used to share data between\nExecutors. Volumes are initialized as empty directories by the\nsystem when the task starts and are mounted at the same path\nin each Executor.\n\nFor example, given a volume defined at `/vol/A`,\nexecutor 1 may write a file to `/vol/A/exec1.out.txt`, then\nexecutor 2 may read from that file.\n\n(Essentially, this translates to a `docker run -v` flag where\nthe container path is the same for each executor).", + "items": { + "type": "unknown" + } + }, + "tags": { + "type": "object", + "example": { + "WORKFLOW_ID": "cwl-01234", + "PROJECT_GROUP": "alice-lab" + }, + "additionalProperties": { + "type": "unknown" + }, + "description": "A key-value map of arbitrary tags. These can be used to store meta-data\nand annotations about a task. Example:\n```\n{\n \"tags\" : {\n \"WORKFLOW_ID\" : \"cwl-01234\",\n \"PROJECT_GROUP\" : \"alice-lab\"\n }\n}\n```" + }, + "logs": { + "type": "array", + "description": "Task logging information.\nNormally, this will contain only one entry, but in the case where\na task fails and is retried, an entry will be appended to this list.", + "readOnly": true, + "items": { + "$ref": "#/components/schemas/tesTaskLog" + } + }, + "creation_time": { + "type": "string", + "description": "Date + time the task was created, in RFC 3339 format.\nThis is set by the system, not the client.", + "example": "2020-10-02T15:00:00.000Z", + "readOnly": true + } + }, + "description": "Task describes an instance of a task." + }, + "tesTaskLog": { + "required": [ + "logs", + "outputs" + ], + "type": "object", + "properties": { + "logs": { + "type": "array", + "description": "Logs for each executor", + "items": { + "$ref": "#/components/schemas/tesExecutorLog" + } + }, + "metadata": { + "type": "unknown", + "additionalProperties": { + "type": "string" + }, + "description": "Arbitrary logging metadata included by the implementation.", + "example": { + "host": "worker-001", + "slurmm_id": 123456 + } + }, + "start_time": { + "type": "string", + "description": "When the task started, in RFC 3339 format.", + "example": "2020-10-02T15:00:00.000Z" + }, + "end_time": { + "type": "unknown", + "description": "When the task ended, in RFC 3339 format.", + "example": "2020-10-02T16:00:00.000Z" + }, + "outputs": { + "type": "array", + "description": "Information about all output files. Directory outputs are\nflattened into separate items.", + "items": { + "$ref": "#/components/schemas/tesOutputFileLog" + } + }, + "system_logs": { + "type": "array", + "description": "System logs are any logs the system decides are relevant,\nwhich are not tied directly to an Executor process.\nContent is implementation specific: format, size, etc.\n\nSystem logs may be collected here to provide convenient access.\n\nFor example, the system may include the name of the host\nwhere the task is executing, an error message that caused\na SYSTEM_ERROR state (e.g. disk is full), etc.\n\nSystem logs are only included in the FULL task view.", + "items": { + "type": "string" + } + } + }, + "description": "TaskLog describes logging information related to a Task." + }, + "ServiceType": { + "description": "Type of a GA4GH service", + "type": "object", + "required": [ + "group", + "artifact", + "version" + ], + "properties": { + "group": { + "type": "string", + "description": "Namespace in reverse domain name format. Use `org.ga4gh` for implementations compliant with official GA4GH specifications. For services with custom APIs not standardized by GA4GH, or implementations diverging from official GA4GH specifications, use a different namespace (e.g. your organization's reverse domain name).", + "example": "org.ga4gh" + }, + "artifact": { + "type": "unknown", + "description": "Name of the API or GA4GH specification implemented. Official GA4GH types should be assigned as part of standards approval process. Custom artifacts are supported.", + "example": "beacon" + }, + "version": { + "type": "string", + "description": 42, + "example": "1.0.0" + } + } + }, + "Service": { + "description": "GA4GH service", + "type": "object", + "required": [ + "id", + "name", + "type", + "organization", + "version" + ], + "properties": { + "id": { + "type": "string", + "description": "Unique ID of this service. Reverse domain name notation is recommended, though not required. The identifier should attempt to be globally unique so it can be used in downstream aggregator services e.g. Service Registry.", + "example": "org.ga4gh.myservice" + }, + "name": { + "type": "string", + "description": "Name of this service. Should be human readable.", + "example": "My project" + }, + "type": { + "$ref": "#/components/schemas/ServiceType" + }, + "description": { + "type": "unknown", + "description": "Description of the service. Should be human readable and provide information about the service.", + "example": "This service provides..." + }, + "organization": { + "type": "object", + "description": "Organization providing the service", + "required": [ + "name", + "url" + ], + "properties": { + "name": { + "type": "unknown", + "description": "Name of the organization responsible for the service", + "example": "My organization" + }, + "url": { + "type": "string", + "format": "uri", + "description": "URL of the website of the organization (RFC 3986 format)", + "example": "https://example.com" + } + } + }, + "contactUrl": { + "type": "string", + "format": "uri", + "description": "URL of the contact for the provider of this service, e.g. a link to a contact form (RFC 3986 format), or an email (RFC 2368 format).", + "example": "mailto:support@example.com" + }, + "documentationUrl": { + "type": "string", + "format": "uri", + "description": "URL of the documentation of this service (RFC 3986 format). This should help someone learn how to use your service, including any specifics required to access data, e.g. authentication.", + "example": "https://docs.myservice.example.com" + }, + "createdAt": { + "type": "string", + "format": "date-time", + "description": "Timestamp describing when the service was first deployed and available (RFC 3339 format)", + "example": "2019-06-04T12:58:19Z" + }, + "updatedAt": { + "type": "unknown", + "format": "date-time", + "description": "Timestamp describing when the service was last updated (RFC 3339 format)", + "example": "2019-06-04T12:58:19Z" + }, + "environment": { + "type": "string", + "description": "Environment the service is running in. Use this to distinguish between production, development and testing/staging deployments. Suggested values are prod, test, dev, staging. However this is advised and not enforced.", + "example": "test" + }, + "version": { + "type": "string", + "description": "Version of the service being described. Semantic versioning is recommended, but other identifiers, such as dates or commit hashes, are also allowed. The version should be changed whenever the service is updated.", + "example": "1.0.0" + } + } + } + } + } +} \ No newline at end of file