Merge pull request linode#67 from linode/release-1.0.3

Release 1.0.3

Author: leslitagordita

README.md

@@ -12,13 +12,19 @@ you may need to install the Gatsby CLI as well `npm install -g gatsby-cli`
 
 Check out the site at http://localhost:8000/
 
+If you'd like to use a local YAML file to build the API docs, run:
+
+`yarn develop [relative-path-to-your-local-YAML-file]`
+
+ex: `yarn develop ../linode-api-docs/openapi.yaml`
+
 ### Build
 
 The API documentation in this site is also indexed in Algolia, so that
 it can be searched across Linode's services. The scripts for this are
 located in the `/search` directory. In order to run them correctly,
-you will need to create a `.env` file in the root directory with the 
+you will need to create a `.env` file in the root directory with the
 following values:
 
 ALGOLIA_API_KEY=(your key here)
-ALGOLIA_API_SECRET=(your secret here)
+ALGOLIA_API_SECRET=(your secret here)

develop.sh

@@ -0,0 +1,4 @@
+#!/bin/bash
+
+bash ./getDependencies.sh ${1}
+gatsby develop;

getDependencies.sh

@@ -1,24 +1,40 @@
 BLUE='\033[0;34m'
 NC='\033[0m' # No Color
 
+SPEC_FILE=""
+if [ -n ${1} ]; then
+  SPEC_FILE=../${1}
+  echo $([ -f $SPEC_FILE ])
+fi
+
 echo
-echo "${BLUE}Fetching base theme${NC}"
+printf "${BLUE}Fetching base theme${NC}\n"
 if
   cd linode-hugo-theme; then
   git pull origin development; else
   git clone https://github.com/linode/linode-hugo-theme.git;
 fi
 
-echo
-echo "${BLUE}Fetching API specs${NC}"
-cd -
-curl https://raw.githubusercontent.com/linode/linode-api-docs/master/openapi.yaml > static/api/docs/v4/openapi.yaml
+if [ -f "$SPEC_FILE" ]; then
+  echo
+  printf "${BLUE}Using local spec file at: ${SPEC_FILE}${NC}\n"
+  cat $SPEC_FILE > ../static/api/docs/v4/openapi.yaml;
+  cd -
+else
+  echo
+  printf "${BLUE}Fetching API specs${NC}\n"
+  cd -
+  curl https://raw.githubusercontent.com/linode/linode-api-docs/master/openapi.yaml > static/api/docs/v4/openapi.yaml;
+fi
 
 echo
-echo "${BLUE}Removing faulty data${NC}"
+printf "${BLUE}Removing faulty data${NC}\n"
 sed -i.bak '/backgroundColor:/d' static/api/docs/v4/openapi.yaml
 rm static/api/docs/v4/openapi.yaml.bak
 
 echo
-echo "${BLUE}Converting YAML to JSON${NC}"
-./node_modules/yamljs/bin/yaml2json static/api/docs/v4/openapi.yaml > static/api/docs/v4/spec.json
+printf "${BLUE}Converting YAML to JSON${NC}\n"
+node_modules/yamljs/bin/yaml2json static/api/docs/v4/openapi.yaml > static/api/docs/v4/spec.json
+# some data manipulation to fix the result of the conversion above
+sed -i.bak 's@\\\\[[:space:]]@\\\\\\n @g' static/api/docs/v4/spec.json
+rm static/api/docs/v4/spec.json.bak

package.json

@@ -50,7 +50,7 @@
   ],
   "scripts": {
     "build": "./getDependencies.sh && gatsby build && node search/buildIndex.js",
-    "develop": "./getDependencies.sh && gatsby develop",
+    "develop": "./develop.sh",
     "start": "npm run develop",
     "serve": "gatsby serve",
     "test": "echo \"Write tests! -> https://gatsby.app/unit-testing\""

src/components/2_molecules/BodySchema.js

@@ -2,6 +2,7 @@ import { getOr } from "lodash/fp";
 import React from "react";
 import Markdown from "react-markdown/with-html";
 
+import Enum from "./Enum";
 import Filterable from "./Filterable";
 import Nullable from "./Nullable";
 import SubResponse from "./SubResponse";
@@ -97,6 +98,7 @@ export const BodySchema = props => {
                           <span className="tag tag-deprecated">Deprecated</span>
                         </div>
                       )}
+                      {b.enum && <Enum dataSource={b} />}
                       <Markdown
                         source={b.description}
                         escapeHtml={false}

src/components/2_molecules/paramDisplay.js

@@ -1,4 +1,5 @@
 import React from "react";
+import Markdown from "react-markdown/with-html";
 
 export const ParamDisplay = props => {
   const { param } = props;
@@ -38,7 +39,15 @@ export const ParamDisplay = props => {
                 <span className="tag tag-light">{param.schema.default}</span>
               </div>
             )}
-            {param.description && <div>{param.description}</div>}
+            {param.description && (
+              <div>
+                <Markdown
+                  source={param.description}
+                  escapeHtml={false}
+                  className="api-desc"
+                />
+              </div>
+            )}
           </div>
         </div>
       </div>

src/components/5_templates/api.js

@@ -120,26 +120,26 @@ class apiPage extends React.Component {
                           className="my-8 api-desc"
                         />
                         {m.security && <Security oauth={m.security[1].oauth} />}
-                        {m.parameters && (
+                        {n.parameters && (
                           <div className="my-8">
-                            <h3 className="mb-2">Query Parameters</h3>
-                            {m.parameters.map((param, i) => (
+                            <h3 className="mb-2">Path Parameters</h3>
+                            {n.parameters.map((param, i) => (
                               <ParamDisplay
                                 key={`param-item-${i}`}
                                 param={param}
-                                m={m}
+                                m={n}
                               />
                             ))}
                           </div>
                         )}
-                        {n.parameters && (
+                        {m.parameters && (
                           <div className="my-8">
-                            <h3 className="mb-2">Path Parameters</h3>
-                            {n.parameters.map((param, i) => (
+                            <h3 className="mb-2">Query Parameters</h3>
+                            {m.parameters.map((param, i) => (
                               <ParamDisplay
                                 key={`param-item-${i}`}
                                 param={param}
-                                m={n}
+                                m={m}
                               />
                             ))}
                           </div>

src/content/changelog/2019-09-09-api.md

@@ -0,0 +1,41 @@
+---
+title: "4.4.0: 2019-09-09"
+date: "2019-09-09T08:00:00-04:00"
+description: "API Changelog 4.4.0"
+changelog:
+- API
+version: 4.4.0
+---
+
+### Added
+
+- Added a `secondary_entity` property to the [GET /account/events](/api/v4/account-events) and [GET /account/events/{eventId}](/api/v4/account-events-event-id) endpoints. A `secondary_entity` object displays information about an additional entity that is related to the Event. Currently, the `linode_boot`, `linode_create`, and `linode_clone` Event actions can generate a `secondary_entity` object.
+
+- Added convenience Object Storage beta endpoints for the Early Access Program. It is recommended to use the more fully-featured [S3 API](https://docs.ceph.com/docs/mimic/radosgw/s3/#) directly instead of these endpoints. **Note**: these endpoints are prepended with **`/v4beta`** instead of `/v4`.
+
+   - List Object Storage Buckets ([GET /object-storage/buckets](/api/v4/object-storage-buckets))
+   - Create Object Storage Bucket ([POST /object-storage/buckets](/api/v4/object-storage-buckets/#post))
+   - View Object Storage Bucket ([GET /object-storage/buckets/{clusterId}/{bucket}](/api/v4/object-storage-buckets-cluster-id-bucket))
+   - Remove Object Storage Bucket ([DELETE /object-storage/buckets/{clusterId}/{bucket}](/api/v4/object-storage-buckets-cluster-id-bucket/#delete))
+   - Modify Object Storage Bucket Access ([POST /object-storage/buckets/{clusterId}/{bucket}/access](/api/v4/object-storage-buckets-cluster-id-bucket-access/#post))
+   - List Object Storage Bucket Contents ([GET /object-storage/buckets/{clusterId}/{bucket}/object-list](/api/v4/object-storage-buckets-cluster-id-bucket-object-list))
+   - Create Object Storage Object URL ([POST /object-storage/buckets/{clusterId}/{bucket}/object-url](/api/v4/object-storage-buckets-cluster-id-bucket-object-url/#post))
+
+### Changed
+
+- The `group` property of the Managed Contacts ([/managed/contacts](/api/v4/managed-contacts/#post)) resource is no longer deprecated.
+- The `consultation_group` property of the Managed Services ([/managed/services](/api/v4/managed-services)) resource is no longer deprecated.
+
+### Fixed
+
+- Previously, you could initiate a cross data center (DC) migration ([POST /linode/instances/{linodeId}/migrate](/api/v4/linode-instances-linode-id-migrate/#post)) even if the Linode already had a pending migration in the queue. Now, if your Linode has a pending migration already queued, you will not be able to initiate a DC migration until it has completed and you will receive an error response, "Linode has a pending migration."  A list of pending migrations, if any, can be accessed from [GET /account/notifications](/api/v4/account-notifications ).
+
+- Validation to ensure a running Linode is powered down prior to initiating a cross data center (DC) migration ([POST /linode/instances/{linodeId}/migrate](/api/v4/linode-instances-linode-id-migrate/#post)) was removed. This validation is unnecessary because a Linode is automatically powered off, migrated, and then restored to its previous boot state when any Linode migration is initiated.
+
+- The `group` property of a managed contacts resource can now be updated ([PUT /managed/contacts/{contactId}](/api/v4/managed-contacts-contact-id/#put)) with a null value. Previous PUT validation generated an error when the `group` property was updated with a null value.
+
+- When updating ([PUT /linode/stackscripts/{stackscriptId}](/api/v4/linode-stackscripts-stackscript-id/#put)) a StackScripts resource, the `images` property no longer accepts an empty array. Previously, there was no validation in place to prevent an empty `images` property array. This caused a StackScript to no longer be deployable.
+
+- When listing Managed Services ([GET /managed/services](/api/v4/managed-services)) on a managed account, removed services no longer appear in the response data.
+
+- A Managed Credential now correctly maps to a Managed Service. Previously, when you created ([POST /managed/services](/api/v4/managed-services/#post)) or updated ([PUT /managed/services/{serviceId}](/api/v4/managed-services-service-id/#put)) a Managed Service with a `credentials` parameter, its Managed Credential Ids did not appropriately map to the service. This resulted in an empty `credentials` array when listing ([GET /managed/services](/api/v4/managed-services)) or viewing ([GET /managed/services/{serviceId}](/api/v4/managed-services-service-id)) a Managed Service.