docs: update all docs

Author: Parth Shandilya

LICENSE

@@ -1,6 +1,6 @@
 The MIT License (MIT)
 
-Copyright (c) 2016 Ivan Goncharov
+Copyright (c) 2019-2022 CERN.
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

README.md

@@ -1,6 +1,17 @@
-# CAP API Documentation OpenAPI Specification
+# CERN Analysis Preservation REST API Documentation
+
+### About
+
+This is the documentation behind the REST API for [CERN Analysis Preservation](https://analysispreservation.cern.ch/).
+
+Other documentation:
+- [CERN Analysis Preservation Docs](https://analysispreservation.cern.ch/docs/general/)
+- [CERN Analysis Preservation Client](https://analysispreservation.cern.ch/docs/cli/)
+
+If you need help or have a question about the API Documentation, please contact us via our [email](analysis-preservation-support@cern.ch).
+
+# OpenAPI Specification
 
-## Working on specification
 ### Install
 
 1. Install [Node JS](https://nodejs.org/)
@@ -18,4 +29,4 @@ Bundles the spec and prepares web_deploy folder with static assets.
 Validates the spec.
 
 #### `npm run gh-pages`
-Deploys docs to GitHub Pages. You don't need to run it manually if you have Travis CI configured.
+Deploys docs to GitHub Pages.

spec/code_samples/C#/records/post.cs

@@ -0,0 +1,12 @@
+value:
+  size: 442
+  delete_marker: false
+  links: {}
+  created: "2022-04-20T13:13:01.105707+00:00"
+  updated: "2022-04-20T13:13:01.113000+00:00"
+  tags: {}
+  version_id: b5f224ef-efe2-4ea5-9b47-d13623dd47bb
+  is_head: true
+  key: testname
+  mimetype: text/plain
+  checksum: md5:c63fcd62028c636019556ee6a1f2f62c

spec/code_samples/PHP/records/post.php

@@ -0,0 +1,9 @@
+value:
+  latest:
+    links: {}
+    version: 0.0.2
+  versions:
+    - links: {}
+      version: 0.0.1
+    - links: {}
+      version: 0.0.2 

spec/code_samples/Python/records/get.py

@@ -6,10 +6,9 @@ value:
   fullname: MySchema Analysis
   is_indexed: true
   links:
-    deposit: >-
-      https://analysispreservation.cern.ch/schemas/deposits/records/myschema-v0.0.1.json
-    record: 'https://analysispreservation.cern.ch/schemas/records/myschema-v0.0.1.json'
-    self: 'http://localhost:5000/api/jsonschemas/myschema/0.0.1'
+    deposit: https://analysispreservation.cern.ch/api/schemas/deposits/records/myschema-v0.0.1.json
+    record: https://analysispreservation.cern.ch/api/schemas/records/myschema-v0.0.1.json
+    self: https://analysispreservation.cern/ch/api/jsonschemas/myschema/0.0.1
   name: myschema
   record_mapping: {}
   record_options: {}

spec/code_samples/README.md

@@ -0,0 +1,32 @@
+value:
+  contents:
+    - mimetype: application/x-sh
+      delete_marker: false
+      tags: {}
+      links:
+        self: >-
+          https://analysispreservation.cern/ch/api/files/d0d4a30c-0d54-4ae3-ac0a-18fb982aad5f/hello/world/redirects.sh
+        version: >-
+          https://analysispreservation.cern/ch/api/files/d0d4a30c-0d54-4ae3-ac0a-18fb982aad5f/hello/world/redirects.sh?versionId=5d7e05ea-7c7c-48b9-913b-8ebadf26182e
+        uploads: >-
+          https://analysispreservation.cern/ch/api/files/d0d4a30c-0d54-4ae3-ac0a-18fb982aad5f/hello/world/redirects.sh?uploads
+      size: 163
+      is_head: true
+      version_id: 5d7e05ea-7c7c-48b9-913b-8ebadf26182e
+      checksum: 'md5:b8c74d3430930c8ee0f1b53e525175ba'
+      updated: '2020-10-12T13:39:07.880982+00:00'
+      key: hello/world/redirects.sh
+      created: '2020-10-12T13:39:07.871349+00:00'
+  locked: false
+  links:
+    self: 'https://analysispreservation.cern/ch/api/files/d0d4a30c-0d54-4ae3-ac0a-18fb982aad5f'
+    versions: >-
+      https://analysispreservation.cern/ch/api/files/d0d4a30c-0d54-4ae3-ac0a-18fb982aad5f?versions
+    uploads: >-
+      https://analysispreservation.cern/ch/api/files/d0d4a30c-0d54-4ae3-ac0a-18fb982aad5f?uploads
+  size: 8425
+  updated: '2020-10-12T13:39:07.894887+00:00'
+  id: d0d4a30c-0d54-4ae3-ac0a-18fb982aad5f
+  max_file_size: null
+  quota_size: null
+  created: '2020-10-12T13:21:40.302308+00:00'