From e53b750081174db20a9560d452f7a9b4ad311038 Mon Sep 17 00:00:00 2001 From: Vincent Shadbolt Date: Tue, 19 Nov 2024 15:04:43 -0800 Subject: [PATCH 01/11] Removed API Spec section from sidebar for cleaner UI --- getting-started/sidebars.yaml | 29 ++++------------------------- 1 file changed, 4 insertions(+), 25 deletions(-) diff --git a/getting-started/sidebars.yaml b/getting-started/sidebars.yaml index 3973e3f1..ca4c56dc 100644 --- a/getting-started/sidebars.yaml +++ b/getting-started/sidebars.yaml @@ -44,21 +44,10 @@ pages: - label: "Overview" page: ../resolution/guides/reverse-resolution/overview.md - - label: Smart Contract Integration Guide + - label: Smart Contract Integration page: ../resolution/guides/reverse-resolution/integration-guides/smart-contracts.md - - label: Resolution Libraries Integration Guide + - label: Resolution Libraries Integration page: ../resolution/guides/reverse-resolution/integration-guides/resolution-libraries.md - - group: Resolution Service API Integration Guides - expanded: false - pages: - - label: Overview - href: /developer-toolkit/resolution-integration-methods/resolution-service/overview/ - - label: Get Reverse Record for an Address - href: /developer-toolkit/resolution-integration-methods/resolution-service/endpoints/get-reverse-record-for-address/ - - label: Get Reverse Record for Multiple Addresses - href: /developer-toolkit/resolution-integration-methods/resolution-service/endpoints/get-reverse-record-for-multiple-addresses/ - - label: Error Codes - href: /developer-toolkit/resolution-integration-methods/resolution-service/error-codes/ - label: FAQs page: ../resolution/guides/reverse-resolution/faq.md - label: Resolution CLI @@ -70,10 +59,10 @@ - group: Tech References expanded: false pages: - - label: API Reference - page: ../openapi/resolution.page.yaml - label: Records reference page: ../resolution/records-reference.md + - label: API Reference + page: ../openapi/resolution.page.yaml - group: Smart Contracts expanded: false pages: @@ -233,13 +222,3 @@ page: ../smart-contracts/overview/cns-uns-comparison.md - label: "Namehashing" page: domain-registry-essentials/namehashing.md - separatorLine: true -- group: API Specs - expanded: false - pages: - - page: ../openapi/resolution.page.yaml - - page: ../openapi/partner.page.yaml - - page: ../openapi/profile-v1.page.yaml - - page: ../openapi/messaging-v1.page.yaml - - page: ../openapi/loginref.page.yaml - - page: ../openapi/registry.page.yaml From f896867f8aa94dfae1c1b2d36efdd493b153671e Mon Sep 17 00:00:00 2001 From: Vincent Shadbolt Date: Thu, 5 Dec 2024 10:43:41 -0800 Subject: [PATCH 02/11] added redirect for partner/latest to partner/ --- redirects.yaml | 3 +++ 1 file changed, 3 insertions(+) diff --git a/redirects.yaml b/redirects.yaml index 2072c95a..20d9a179 100644 --- a/redirects.yaml +++ b/redirects.yaml @@ -274,3 +274,6 @@ '/developer-toolkit/resolution-integration-methods/resolution-service/*': to: '/openapi/resolution/' type: 301 +'/openapi/partner/latest': + to: '/openapi/partner/' + type: 301 \ No newline at end of file From 80f00295551267d78b188006f69c91b733d36311 Mon Sep 17 00:00:00 2001 From: Vincent Shadbolt Date: Tue, 10 Dec 2024 13:55:50 -0800 Subject: [PATCH 03/11] relocated sidebars.yaml to project root --- getting-started/sidebars.yaml | 224 -------------------------------- sidebars.yaml | 233 ++++++++++++++++++++++++++++++++++ 2 files changed, 233 insertions(+), 224 deletions(-) delete mode 100644 getting-started/sidebars.yaml create mode 100644 sidebars.yaml diff --git a/getting-started/sidebars.yaml b/getting-started/sidebars.yaml deleted file mode 100644 index ca4c56dc..00000000 --- a/getting-started/sidebars.yaml +++ /dev/null @@ -1,224 +0,0 @@ -- group: Getting Started - expanded: false - pages: - - label: "Overview" - page: overview.md - - group: Get a Test Domain - expanded: false - pages: - - label: UD Website Faucet Guide - page: test-domains/faucet.md - - label: Polygon Faucet Guide - page: test-domains/polygonscan.md - - label: Glossary - page: glossary.md - separatorLine: true -- group: Resolution - expanded: false - pages: - - label: "Overview" - page: ../resolution/overview.md - - group: Quickstart - expanded: false - pages: - - label: Retrieve an API Key - page: ../resolution/quickstart/retrieve-an-api-key.md - - label: Resolve Domains - page: ../resolution/quickstart/resolution.md - - label: Reverse Resolve Domains - page: ../resolution/quickstart/reverse-resolution.md - - group: Guides - expanded: false - pages: - - group: Browser resolution (HTTP & IPFS) - expanded: false - pages: - - label: Overview - page: ../resolution/guides/browser-resolution/overview.md - - label: Algorithm - page: ../resolution/guides/browser-resolution/algorithm.md - - label: Test domains - page: ../resolution/guides/browser-resolution/test-domains.md - - group: Reverse Resolution - expanded: false - pages: - - label: "Overview" - page: ../resolution/guides/reverse-resolution/overview.md - - label: Smart Contract Integration - page: ../resolution/guides/reverse-resolution/integration-guides/smart-contracts.md - - label: Resolution Libraries Integration - page: ../resolution/guides/reverse-resolution/integration-guides/resolution-libraries.md - - label: FAQs - page: ../resolution/guides/reverse-resolution/faq.md - - label: Resolution CLI - page: ../resolution/sdks-and-libraries/cli.md - - label: Best practices - page: ../resolution/guides/best-practices.md - - label: Troubleshooting - page: ../resolution/guides/troubleshooting-guide.md - - group: Tech References - expanded: false - pages: - - label: Records reference - page: ../resolution/records-reference.md - - label: API Reference - page: ../openapi/resolution.page.yaml - - group: Smart Contracts - expanded: false - pages: - - label: Resolution Contracts - page: ../smart-contracts/quick-start/resolve-domains.md - - label: Reverse Resolution Contracts - page: ../smart-contracts/quick-start/reverse-resolve-domains.md - - group: SDKs and Libraries - expanded: false - pages: - - label: Overview - page: ../resolution/sdks-and-libraries/overview.md - - label: JavaScript - page: ../resolution/sdks-and-libraries/javascript.md - - label: Java - page: ../resolution/sdks-and-libraries/java.md - - label: Swift - page: ../resolution/sdks-and-libraries/swift.md - - label: Go - page: ../resolution/sdks-and-libraries/go.md - - label: Matic.js SDK - page: ../resolution/sdks-and-libraries/maticjs.md - separatorLine: true -- group: Partner API - expanded: false - pages: - - label: "Overview" - page: ../domain-distribution-and-management/overview.md - - group: Quickstart - expanded: false - pages: - - label: Retrieve an API key - page: ../domain-distribution-and-management/quickstart/retrieve-an-api-key.md - - group: Guides - expanded: false - pages: - - label: Implement Webhooks - page: ../domain-distribution-and-management/guides/implementing-webhooks.md - - label: On-chain Buy - page: ../domain-distribution-and-management/guides/on-chain-buy.md - - group: Tech References - expanded: false - pages: - - label: Partner API - page: ../openapi/partner.page.yaml - - group: Smart Contracts - expanded: false - pages: - - label: Manage Domain Records - page: ../smart-contracts/quick-start/manage-domain-records.md - - label: Mint Subdomains - page: ../smart-contracts/quick-start/mint-subdomains.md - separatorLine: true -- group: Login With Unstoppable - expanded: false - pages: - - label: Overview - page: ../identity/overview/login-with-unstoppable.md - - group: Quickstart - expanded: false - pages: - - label: Retrieve Client Credentials - page: ../identity/quickstart/retrieve-client-credentials.md - - label: Login with Pop-Up - page: ../identity/quickstart/login-with-pop-up.md - - group: Guides - expanded: false - pages: - - group: Integration Paths - expanded: false - pages: - - label: Login without Pop-Up - page: ../identity/guides/integration-paths/login-without-pop-up.md - - label: Node.js - page: ../identity/guides/integration-paths/node-js.md - - label: Web3 Modal - page: ../identity/guides/integration-paths/web3-modal.md - - label: Web3 React - page: ../identity/guides/integration-paths/web3-react.md - - label: Web3 Onboard - page: ../identity/guides/integration-paths/web3-onboard.md - - label: Moralis - page: ../identity/guides/integration-paths/moralis.md - - label: Auth0 - page: ../identity/guides/integration-paths/auth0.md - - label: WAGMI - page: ../identity/guides/integration-paths/wagmi.md - - label: Client Configurations - page: ../identity/guides/client-configurations.md - - label: Login Scopes - page: ../identity/guides/login-scopes.md - - label: Display Users Domain - page: ../identity/guides/display-users-domain.md - - label: Best Practices - page: ../identity/guides/best-practices.mdx - - label: Troubleshooting - page: ../identity/guides/troubleshooting.md - - label: FAQs - page: ../identity/guides/faq.md - - group: Tech References - expanded: false - pages: - - group: API Reference - expanded: false - pages: - - label: Unstoppable Login API - page: ../openapi/loginref.page.yaml - - label: Profile API - page: ../openapi/profile-v1.page.yaml - - label: Messaging API - page: ../openapi/messaging-v1.page.yaml - - label: Error codes - page: ../identity/api-reference/error-codes.md - - group: Login Protocols - expanded: false - pages: - - label: Authorization Server - page: ../identity/guides/login-protocols/authorization-server.md - - label: Authentication Protocol - page: ../identity/guides/login-protocols/authentication-protocol.md - - group: SDKs and Libraries - expanded: false - pages: - - label: Overview - page: ../identity/sdk-and-libraries/overview.md - - label: UAuth JS - page: ../identity/sdk-and-libraries/uauth-js.md - - label: UAuth Node - page: ../identity/sdk-and-libraries/uauth-node.md - - label: Web3 React - page: ../identity/sdk-and-libraries/web3-react.md - - label: Web3 Modal - page: ../identity/sdk-and-libraries/web3-modal.md - - label: Web3 Onboard - page: ../identity/sdk-and-libraries/web3-onboard.md - - label: Moralis - page: ../identity/sdk-and-libraries/moralis.md - separatorLine: true -- group: Contract Architecture - expanded: false - pages: - - group: UNS Architecture - expanded: false - pages: - - label: "Overview" - page: ../smart-contracts/overview/uns-architecture-overview.md - - label: "Smart Contract" - page: ../smart-contracts/contract-reference/uns-smart-contracts.md - - group: CNS Architecture - expanded: false - pages: - - label: "Overview" - page: ../smart-contracts/overview/cns-architecture-overview.md - - label: "Smart Contract" - page: ../smart-contracts/contract-reference/cns-smart-contracts.md - - label: "CNS vs UNS Comparison" - page: ../smart-contracts/overview/cns-uns-comparison.md - - label: "Namehashing" - page: domain-registry-essentials/namehashing.md diff --git a/sidebars.yaml b/sidebars.yaml new file mode 100644 index 00000000..2eb5ae1c --- /dev/null +++ b/sidebars.yaml @@ -0,0 +1,233 @@ +- group: Getting Started + expanded: false + pages: + - label: "Overview" + page: getting-started/overview.md + - group: Get a Test Domain + expanded: false + pages: + - label: UD Website Faucet Guide + page: getting-started/test-domains/faucet.md + - label: Polygon Faucet Guide + page: getting-started/test-domains/polygonscan.md + - label: Glossary + page: getting-started/glossary.md + separatorLine: true +- group: Resolution + expanded: false + pages: + - label: "Overview" + page: resolution/overview.md + - group: Quickstart + expanded: false + pages: + - label: Retrieve an API Key + page: resolution/quickstart/retrieve-an-api-key.md + - label: Resolve Domains + page: resolution/quickstart/resolution.md + - label: Reverse Resolve Domains + page: resolution/quickstart/reverse-resolution.md + - group: Guides + expanded: false + pages: + - group: Browser resolution (HTTP & IPFS) + expanded: false + pages: + - label: Overview + page: resolution/guides/browser-resolution/overview.md + - label: Algorithm + page: resolution/guides/browser-resolution/algorithm.md + - label: Test domains + page: resolution/guides/browser-resolution/test-domains.md + - group: Reverse Resolution + expanded: false + pages: + - label: "Overview" + page: resolution/guides/reverse-resolution/overview.md + - label: Smart Contract Integration + page: resolution/guides/reverse-resolution/integration-guides/smart-contracts.md + - label: Resolution Libraries Integration + page: resolution/guides/reverse-resolution/integration-guides/resolution-libraries.md + - label: FAQs + page: resolution/guides/reverse-resolution/faq.md + - label: Resolution CLI + page: resolution/sdks-and-libraries/cli.md + - label: Best practices + page: resolution/guides/best-practices.md + - label: Troubleshooting + page: resolution/guides/troubleshooting-guide.md + - group: Tech References + expanded: false + pages: + - group: API Reference + expanded: false + pages: + - label: Resolution + page: openapi/resolution.page.yaml + - label: Records reference + page: resolution/records-reference.md + - group: Smart Contracts + expanded: false + pages: + - label: Resolution Contracts + page: smart-contracts/quick-start/resolve-domains.md + - label: Reverse Resolution Contracts + page: smart-contracts/quick-start/reverse-resolve-domains.md + - group: SDKs and Libraries + expanded: false + pages: + - label: Overview + page: resolution/sdks-and-libraries/overview.md + - label: JavaScript + page: resolution/sdks-and-libraries/javascript.md + - label: Java + page: resolution/sdks-and-libraries/java.md + - label: Swift + page: resolution/sdks-and-libraries/swift.md + - label: Go + page: resolution/sdks-and-libraries/go.md + - label: Matic.js SDK + page: resolution/sdks-and-libraries/maticjs.md + separatorLine: true +- group: Partner API + expanded: false + pages: + - label: "Overview" + page: domain-distribution-and-management/overview.md + - group: Quickstart + expanded: false + pages: + - label: Retrieve an API key + page: domain-distribution-and-management/quickstart/retrieve-an-api-key.md + - group: Guides + expanded: false + pages: + - label: Implement Webhooks + page: domain-distribution-and-management/guides/implementing-webhooks.md + - label: On-chain Buy + page: domain-distribution-and-management/guides/on-chain-buy.md + - group: Tech References + expanded: false + pages: + - group: API Reference + expanded: false + pages: + - label: Partner API + page: openapi/partner.page.yaml + - group: Smart Contracts + expanded: false + pages: + - label: Manage Domain Records + page: smart-contracts/quick-start/manage-domain-records.md + - label: Mint Subdomains + page: smart-contracts/quick-start/mint-subdomains.md + separatorLine: true +- group: Login With Unstoppable + expanded: false + pages: + - label: Overview + page: identity/overview/login-with-unstoppable.md + - group: Quickstart + expanded: false + pages: + - label: Retrieve Client Credentials + page: identity/quickstart/retrieve-client-credentials.md + - label: Login with Pop-Up + page: identity/quickstart/login-with-pop-up.md + - group: Guides + expanded: false + pages: + - group: Integration Paths + expanded: false + pages: + - label: Login without Pop-Up + page: identity/guides/integration-paths/login-without-pop-up.md + - label: Node.js + page: identity/guides/integration-paths/node-js.md + - label: Web3 Modal + page: identity/guides/integration-paths/web3-modal.md + - label: Web3 React + page: identity/guides/integration-paths/web3-react.md + - label: Web3 Onboard + page: identity/guides/integration-paths/web3-onboard.md + - label: Moralis + page: identity/guides/integration-paths/moralis.md + - label: Auth0 + page: identity/guides/integration-paths/auth0.md + - label: WAGMI + page: identity/guides/integration-paths/wagmi.md + - label: Client Configurations + page: identity/guides/client-configurations.md + - label: Login Scopes + page: identity/guides/login-scopes.md + - label: Display Users Domain + page: identity/guides/display-users-domain.md + - label: Best Practices + page: identity/guides/best-practices.mdx + - label: Troubleshooting + page: identity/guides/troubleshooting.md + - label: FAQs + page: identity/guides/faq.md + - group: Tech References + expanded: false + pages: + - group: API Reference + expanded: false + pages: + - label: Unstoppable Login API + page: openapi/loginref.page.yaml + - label: Profile API + page: openapi/profile-v1.page.yaml + - label: Messaging API + page: openapi/messaging-v1.page.yaml + - label: Error codes + page: identity/api-reference/error-codes.md + - group: Login Protocols + expanded: false + pages: + - label: Authorization Server + page: identity/guides/login-protocols/authorization-server.md + - label: Authentication Protocol + page: identity/guides/login-protocols/authentication-protocol.md + - group: SDKs and Libraries + expanded: false + pages: + - label: Overview + page: identity/sdk-and-libraries/overview.md + - label: UAuth JS + page: identity/sdk-and-libraries/uauth-js.md + - label: UAuth Node + page: identity/sdk-and-libraries/uauth-node.md + - label: Web3 React + page: identity/sdk-and-libraries/web3-react.md + - label: Web3 Modal + page: identity/sdk-and-libraries/web3-modal.md + - label: Web3 Onboard + page: identity/sdk-and-libraries/web3-onboard.md + - label: Moralis + page: identity/sdk-and-libraries/moralis.md + separatorLine: true +- group: Contract Architecture + expanded: false + pages: + - group: UNS Architecture + expanded: false + pages: + - label: "Overview" + page: smart-contracts/overview/uns-architecture-overview.md + - label: "Smart Contract" + page: smart-contracts/contract-reference/uns-smart-contracts.md + - group: CNS Architecture + expanded: false + pages: + - label: "Overview" + page: smart-contracts/overview/cns-architecture-overview.md + - label: "Smart Contract" + page: smart-contracts/contract-reference/cns-smart-contracts.md + - label: "CNS vs UNS Comparison" + page: smart-contracts/overview/cns-uns-comparison.md + - label: "Namehashing" + page: getting-started/domain-registry-essentials/namehashing.md + separatorLine: true +- link: openapi/resolution/ + label: API Reference From a34a6cf4b7705b26017213f646f00302ed45ed0d Mon Sep 17 00:00:00 2001 From: Vincent Shadbolt Date: Tue, 10 Dec 2024 14:56:59 -0800 Subject: [PATCH 04/11] updated supported TLDs --- getting-started/test-domains/polygonscan.md | 11 +++++ identity/overview/login-with-unstoppable.md | 46 ++------------------- snippets/_supported-domain-endings.md | 2 +- 3 files changed, 15 insertions(+), 44 deletions(-) diff --git a/getting-started/test-domains/polygonscan.md b/getting-started/test-domains/polygonscan.md index 18eef3da..9d6cdd2e 100644 --- a/getting-started/test-domains/polygonscan.md +++ b/getting-started/test-domains/polygonscan.md @@ -71,16 +71,20 @@ You can locate the domain ending [namehash](../domain-registry-essentials/nameha 0x9bf15275eb85f2e69308f3dbfbe0f94cade4f05c2aa24ba7b9eba5ad2fb1a2cb = 'altimist'; 0xaf4d61a6acdda7379d6f90207923aeb080994d0f1aaba4b8b24a14f965b2bb7c = 'anime'; 0x89e68000b532da79f9a0d4b8416eaa4f64294236ab233205343453d5bec22933 = 'austin'; +0x3fa9586c8b0c91c603728cff1ac819679a70197b33df9263d68750d8601fdf1f = 'bald'; 0xd18112ce73608918c5c7f42ba03229594ecd9dafbd427b54e0de6c6ab67e03f5 = 'benji'; 0x2a91107027b89ab420a4d8ec457493cfca12ab17615ec8c876695f1343f3f0fd = 'binanceus'; 0x042fb01c1e43fb4a32f85b41c821e17d2faeac58cfc5fb23f80bc00c940f85e3 = 'bitcoin'; 0xbf2121df4e351413ea6788cb220e735378a753cec288cb22644340d58d597b23 = 'bitget'; 0x4118ebbd893ecbb9f5d7a817c7d8039c1bd991b56ea243e2ae84d0a1b2c950a7 = 'blockchain'; +0xe7371ecc663fd700b2b56cb6141de1de8123261048e3328ea10befbd29100385 = 'boomer'; +0xb8072baa20e712ecf72b7fe107f8f307cf405f57f3b55d72a635fe22cf3c83a3 = 'chomp'; 0x58872a8ca9414ae0f3ab850f51efaf4c77b647d903f9ec89a03d3018bb42e4fa = 'clay'; 0x0f4a10a4f46c288cea365fcf45cccf0e9d901b945b9829ccdb54c10dc3cb7a6f = 'crypto'; 0xb5f2bbf81da581299d4ff7af60560c0ac854196f5227328d2d0c2bb0df33e553 = 'dao'; 0x3b270f4d000c6046ee64e8c025ad8cff71e728b275a81bf53a060442fe9f9766 = 'dfz'; 0x30b126da528ed6a22ad6ce11ea44a16f3990a215ef04115d84bb9275b709e89c = 'dream'; +0xe3ec9fee76a74e3805fcc927d78308ffc19001efd50d94af4c3fc36ed6a34d1d = 'ethermail'; 0xd75c01499ad11caab105cfefbf62ed6f0c7208f8de3fa293f01c209b37a1d036 = 'farms'; 0xa264639c3dbff58a1ded5efcf724e50a9c7847ff8197c87c00d009fbba2a3720 = 'go'; 0xfdb51f7f56d9b1149db5ce99afcf60dda4416fd6fb8dc0649fec13cd03e1803e = 'hi'; @@ -90,21 +94,28 @@ You can locate the domain ending [namehash](../domain-registry-essentials/nameha 0x8a1e62a27632ec008a082a22be9aded2ff7668fdd019e4d4001a5a27c4e84f81 = 'lfg'; 0x57ea207b3238a69d8a9a53252de172f2ceae1d856008b13208a203867a707c78 = 'manga'; 0x46a29e7d78413806ab5b6e30bc360bbff329e7bec2fc3ddf6f62d8c6c17c45b6 = 'metropolis'; +0x3bada31b26c3e299047088ebc099d3cf3b3c4045b214745439add2807d753494 = 'moon'; 0x54b432ba921dd5b52af171de6db29a833e11ba920bc91639bd80222c78e994f5 = 'mumu'; 0xb75cf4f3d8bc3deb317ed5216d898899d5cc6a783f65f6768eb9bcb89428670d = 'nft'; +0xc5f19a061ba3162336fde401da0e2554f72c076fc4b8c15cc7cb243bcfeb4954 = 'npc'; 0xe76cc52c68a868af0cba676c92337a921cc721b45b6630e47f7ecb78e3e0edcc = 'pog'; 0xed9ce6b49a0e2c56c57c86795b131bd6df792312183994c3cf3de1516cfe92d6 = 'polygon'; +0xa5e27fb2696345ec44a24a5c2f7f413d717329c57710aad5f052ae750889edd8 = 'propykeys'; 0x17936dd2b9c99a1e1bfa039dd7d40118f3ed535fcd9c8cda23c8070ffb4c2264 = 'pudgy'; 0x2418c6dc1c5996890c54f1b197ce3d5f255b857445bce309215d0751b56fcd65 = 'raiin'; 0x335f1d8a43ebd6d9277127e859f502a14bbe3ccbe2d3f89be38fd0086da4c396 = 'secret'; 0x670e86e82c6551930f0b729bfa9173a1bfdebc6fb08f49fb97cc0077cae611a1 = 'smobler'; 0x05cb1b6d0e0a38c2fdeacf5d8383eea8f73d8fdeca1e4cc99a0e202f68d5b7df = 'stepn'; 0x241cdd75e86f1a1da99d0321ae7d8e31cdf7c71a31d68b44d8f6f20dfafa9db6 = 'tball'; +0x5b22ab96ce6c7e714dde170ba8568b4ec754a8f7e9b1f8ff79d649a613694ee8 = 'tea'; 0x0adc8e928b9a2309a49011aae110462d6f3642f8b8b0602ccd9a14763ba2f283 = 'ubu'; 0x92bba949890cd44a226a8ce54135cf86538cd6c5ca0ccf41877102fd718cc8aa = 'unstoppable'; +0xa665d9a61cfd00bafc3b436ff2724b2925006051d1456d11219a24425f3c0408 = 'u'; 0x1e3f482b3363eb4710dae2cb2183128e272eafbe137f686851c1caea32502230 = 'wallet'; +0x42b2913f9d847db7f0366ebde961700518fc7ce1d1d392fb57aa879a7a79a973 = 'wifi'; 0xf72e00036d7ef2d56e70c6df1d619bcccb64c93ea5b96305e7d7f24c47b4b563 = 'witg'; 0xacf08822cf871e802cb23fdb2224cb924878985b866b92e55aaae8c0a8a898eb = 'wrkx'; +0x0169ba38fe2e45751c5c0f6af3bb37a1f216ffa0bbad727faf04a1d0949d7730 = 'xmr'; 0x241e7e2b7fd7333b3c0c049b326316b811af0c01cfc0c7a90b466fda3a70fc2d = 'x'; 0xd81bbfcee722494b885e891546eeac23d0eedcd44038d7a2f6ef9ec2f9e0d239 = 'zil'; ``` diff --git a/identity/overview/login-with-unstoppable.md b/identity/overview/login-with-unstoppable.md index c105dfae..237c036d 100644 --- a/identity/overview/login-with-unstoppable.md +++ b/identity/overview/login-with-unstoppable.md @@ -52,49 +52,9 @@ The UAuth protocol extends the standard OpenID Connect (OIDC) authorization prot Unstoppable Login currently supports the following top-level domains (TLDs): -- .888 -- .altimist -- .anime -- .austin -- .benji -- .binanceus -- .bitcoin -- .bitget -- .blockchain -- .clay -- .crypto -- .dao -- .dfz -- .dream -- .farms -- .go -- .hi -- .klever -- .kresus -- .kryptic -- .lfg -- .manga -- .metropolis -- .mumu -- .nft -- .pog -- .polygon -- .pudgy -- .raiin -- .secret -- .smobler -- .stepn -- .tball -- .ubu -- .unstoppable -- .wallet -- .witg -- .wrkx -- .x -- .zil \* -- .eth - -:::warning \* Unstoppable Login only supports `.zil` domains that have been bridged to the Polygon blockchain. + + +:::warning Unstoppable Login only supports `.zil` domains that have been bridged to the Polygon blockchain. ::: ## Considerations diff --git a/snippets/_supported-domain-endings.md b/snippets/_supported-domain-endings.md index ea4b2aa9..ff23c1be 100644 --- a/snippets/_supported-domain-endings.md +++ b/snippets/_supported-domain-endings.md @@ -1,7 +1,7 @@ | Name Service | Supported Domains | | ------------------------------ | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | Zilliqa Name Service (ZNS) | `.zil` | -| Unstoppable Name Service (UNS) | `.x`, `.polygon`, `.nft`, `.crypto`, `.blockchain`, `.bitcoin`, `.dao`, `.888`, `.wallet`, `.binanceus`, `.hi`, `.klever`, `.kresus`, `.anime`, `.manga`, `.go`, `.altimist`, `.pudgy`, `.unstoppable`, `.austin`, `.bitget`, `.pog`, `.clay`, `.witg`, `.metropolis`, `.wrkx`, `.secret`, `.raiin`, `.stepn`, `.kryptic`, `.ubu`, `.tball`, `.farms`, `.dfz`, `.smobler`, `.lfg`, `.dream`, `.benji`, `.mumu` | +| Unstoppable Name Service (UNS) | `.888`, `.altimist`, `.anime`, `.austin`, `.bald`, `.benji`, `.binanceus`, `.bitcoin`, `.bitget`, `.blockchain`, `.boomer`, `.chomp`, `.clay`, `.crypto`, `.dao`, `.dfz`, `.dream`, `.ethermail`, `.farms`, `.go`, `.hi`, `.klever`, `.kresus`, `.kryptic`, `.lfg`, `.manga`, `.metropolis`, `.moon`, `.mumu`, `.nft`, `.npc`, `.pog`, `.polygon`, `.propykeys`, `.pudgy`, `.raiin`, `.secret`, `.smobler`, `.stepn`, `.tball`, `.tea`, `.ubu`, `.unstoppable`, `.u`, `.wallet`, `.wifi`, `.witg`, `.wrkx`, `.xmr`, `.x` | | Ethereum Name Service (ENS) | `.eth` | For the full list, check the [supported TLDs endpoint](https://api.unstoppabledomains.com/resolve/supported_tlds). From f846db0479f05515de1052525a4b1c89c491239c Mon Sep 17 00:00:00 2001 From: Vincent Shadbolt Date: Tue, 10 Dec 2024 15:14:10 -0800 Subject: [PATCH 05/11] Updated API Reference sidebar --- index.mdx | 2 +- openapi/index.page.yaml | 16 ++++++++++++++++ openapi/sidebars.yaml | 2 ++ sidebars.yaml | 2 +- siteConfig.yaml | 2 +- 5 files changed, 21 insertions(+), 3 deletions(-) create mode 100644 openapi/index.page.yaml diff --git a/index.mdx b/index.mdx index e4310a84..e4b3f925 100644 --- a/index.mdx +++ b/index.mdx @@ -47,7 +47,7 @@ export default LandingLayout; Retrieve cryptocurrency addresses, IPFS hashes, and metadata from onchain domains within in your app. - + Consult the documentation and live testing features of Unstoppable Domains APIs, including the Resolution Service API and Partner API. diff --git a/openapi/index.page.yaml b/openapi/index.page.yaml new file mode 100644 index 00000000..a515df60 --- /dev/null +++ b/openapi/index.page.yaml @@ -0,0 +1,16 @@ +type: reference-docs +label: "API Reference" +settings: + pagination: none + corsProxyUrl: https://cors.redoc.ly + showConsole: true + generateCodeSamples: + languages: + - lang: curl + - lang: JavaScript + - lang: Node.js + - lang: Python + - lang: Java + hideDownloadButton: true + sidebar: + - "/openapi/sidebars.yaml" # Use /openapi/sidebars.yaml for sidebar diff --git a/openapi/sidebars.yaml b/openapi/sidebars.yaml index dee699ac..2206062b 100644 --- a/openapi/sidebars.yaml +++ b/openapi/sidebars.yaml @@ -1,4 +1,6 @@ pages: + - page: index.page.yaml + separatorLine: true - page: metadata.page.yaml separatorLine: true - page: resolution.page.yaml diff --git a/sidebars.yaml b/sidebars.yaml index 2eb5ae1c..f929c946 100644 --- a/sidebars.yaml +++ b/sidebars.yaml @@ -229,5 +229,5 @@ - label: "Namehashing" page: getting-started/domain-registry-essentials/namehashing.md separatorLine: true -- link: openapi/resolution/ +- link: openapi/index.page.yaml label: API Reference diff --git a/siteConfig.yaml b/siteConfig.yaml index 9edbb401..c5bfb1a6 100644 --- a/siteConfig.yaml +++ b/siteConfig.yaml @@ -48,7 +48,7 @@ nav: page: getting-started/overview.md - label: API Reference - page: openapi/resolution.page.yaml + page: openapi/index.page.yaml - search: true From 6209427ee0cfc42fe5650b3fd6f69c0e276b9625 Mon Sep 17 00:00:00 2001 From: Vincent Shadbolt Date: Tue, 10 Dec 2024 15:41:02 -0800 Subject: [PATCH 06/11] Added new redirects --- redirects.yaml | 9 +++++++++ 1 file changed, 9 insertions(+) diff --git a/redirects.yaml b/redirects.yaml index 20d9a179..450da534 100644 --- a/redirects.yaml +++ b/redirects.yaml @@ -276,4 +276,13 @@ type: 301 '/openapi/partner/latest': to: '/openapi/partner/' + type: 301 +'/crypto-payments/': + to: '/resolution/overview/' + type: 301 +'/d-websites/': + to: '/resolution/guides/browser-resolution/overview/' + type: 301 +'/manage-domains/': + to: '/smart-contracts/quick-start/manage-domain-records/' type: 301 \ No newline at end of file From 9b5bec02fd8c74a4e11b57d28ffe9c12443d47b3 Mon Sep 17 00:00:00 2001 From: Vincent Shadbolt Date: Tue, 10 Dec 2024 15:43:02 -0800 Subject: [PATCH 07/11] API reference landing page --- openapi/index.page.yaml | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/openapi/index.page.yaml b/openapi/index.page.yaml index a515df60..df421e89 100644 --- a/openapi/index.page.yaml +++ b/openapi/index.page.yaml @@ -1,4 +1,4 @@ -type: reference-docs +type: landing-page label: "API Reference" settings: pagination: none @@ -13,4 +13,4 @@ settings: - lang: Java hideDownloadButton: true sidebar: - - "/openapi/sidebars.yaml" # Use /openapi/sidebars.yaml for sidebar + - "/openapi/sidebars.yaml" From a51054df2b0ecb4b88ddf83c25181118b4f23674 Mon Sep 17 00:00:00 2001 From: Vincent Shadbolt Date: Tue, 10 Dec 2024 15:50:02 -0800 Subject: [PATCH 08/11] API reference index fix --- openapi/index.page.yaml | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/openapi/index.page.yaml b/openapi/index.page.yaml index df421e89..838e75a6 100644 --- a/openapi/index.page.yaml +++ b/openapi/index.page.yaml @@ -1,5 +1,6 @@ -type: landing-page +type: reference-docs label: "API Reference" +definitionId: dummy-definition # Dummy definition to satisfy Redocly's validation settings: pagination: none corsProxyUrl: https://cors.redoc.ly @@ -13,4 +14,4 @@ settings: - lang: Java hideDownloadButton: true sidebar: - - "/openapi/sidebars.yaml" + - "/openapi/sidebars.yaml" From c5e0d1678889e3796c684c99ae40a9143f4471dd Mon Sep 17 00:00:00 2001 From: Vincent Shadbolt Date: Tue, 10 Dec 2024 16:15:52 -0800 Subject: [PATCH 09/11] API reference overview page --- getting-started/overview.md | 2 +- index.mdx | 2 +- openapi/index.page.yaml | 17 ----------------- openapi/overview.md | 28 ++++++++++++++++++++++++++++ openapi/sidebars.yaml | 3 ++- sidebars.yaml | 2 +- siteConfig.yaml | 2 +- 7 files changed, 34 insertions(+), 22 deletions(-) delete mode 100644 openapi/index.page.yaml create mode 100644 openapi/overview.md diff --git a/getting-started/overview.md b/getting-started/overview.md index 14ad6baa..b049bd41 100644 --- a/getting-started/overview.md +++ b/getting-started/overview.md @@ -23,6 +23,6 @@ This portal is organized to support users at all experience levels, from foundat - [Reverse Resolution](/resolution/guides/reverse-resolution/overview.md) - [Unstoppable Partner API](/domain-distribution-and-management/overview.md) - [Unstoppable Login](/identity/overview/login-with-unstoppable.md) -- [API Reference](/openapi/resolution.page.yaml) +- [API Reference](/openapi/overview.md) diff --git a/index.mdx b/index.mdx index e4b3f925..8d23f4a3 100644 --- a/index.mdx +++ b/index.mdx @@ -47,7 +47,7 @@ export default LandingLayout; Retrieve cryptocurrency addresses, IPFS hashes, and metadata from onchain domains within in your app. - + Consult the documentation and live testing features of Unstoppable Domains APIs, including the Resolution Service API and Partner API. diff --git a/openapi/index.page.yaml b/openapi/index.page.yaml deleted file mode 100644 index 838e75a6..00000000 --- a/openapi/index.page.yaml +++ /dev/null @@ -1,17 +0,0 @@ -type: reference-docs -label: "API Reference" -definitionId: dummy-definition # Dummy definition to satisfy Redocly's validation -settings: - pagination: none - corsProxyUrl: https://cors.redoc.ly - showConsole: true - generateCodeSamples: - languages: - - lang: curl - - lang: JavaScript - - lang: Node.js - - lang: Python - - lang: Java - hideDownloadButton: true - sidebar: - - "/openapi/sidebars.yaml" diff --git a/openapi/overview.md b/openapi/overview.md new file mode 100644 index 00000000..8de5515e --- /dev/null +++ b/openapi/overview.md @@ -0,0 +1,28 @@ +--- +title: Overview of the Unstoppable Domains API Reference +description: The UD API Reference portal is both a technical resource. This will be useful for technical readers. +--- + +# Unstoppable Domains API Reference Portal Overview + +This API Reference is designed to help you understand how to build and integrate custom applications using Unstoppable Domains APIs. + +## Before You Begin + +You'll need the following to get started: + +- An [API key](../domain-distribution-and-management/quickstart/retrieve-an-api-key.md) + +## How This Portal Is Organized + +This portal is organized to support users familair with API implementation. If you're new to crypto and blockchain, consider starting with the [Get Started](../getting-started/overview.md) in the top navbar. Advanced users may wish to explore topics like: + +- [Metadata](/openapi/metadata.page.yaml) +- [Resolution](/openapi/resolution.page.yaml) +- [Partner](/openapi/partner.page.yaml) +- [Profile](/openapi/profile-v1.page.yaml) +- [Messaging](/openapi/messaging-v1.page.yaml) +- [Login](/openapi/loginref.page.yaml) +- [Registry](/openapi/registry.page.yaml) + + diff --git a/openapi/sidebars.yaml b/openapi/sidebars.yaml index 2206062b..ca7afb0e 100644 --- a/openapi/sidebars.yaml +++ b/openapi/sidebars.yaml @@ -1,5 +1,6 @@ pages: - - page: index.page.yaml + - page: overview.md + label: Overview separatorLine: true - page: metadata.page.yaml separatorLine: true diff --git a/sidebars.yaml b/sidebars.yaml index f929c946..825c1944 100644 --- a/sidebars.yaml +++ b/sidebars.yaml @@ -229,5 +229,5 @@ - label: "Namehashing" page: getting-started/domain-registry-essentials/namehashing.md separatorLine: true -- link: openapi/index.page.yaml +- link: /openapi/overview/ label: API Reference diff --git a/siteConfig.yaml b/siteConfig.yaml index c5bfb1a6..7f113aaf 100644 --- a/siteConfig.yaml +++ b/siteConfig.yaml @@ -48,7 +48,7 @@ nav: page: getting-started/overview.md - label: API Reference - page: openapi/index.page.yaml + page: openapi/overview.md - search: true From 0899f1c7bdf45a37de6e259d03469aa700c2e1f1 Mon Sep 17 00:00:00 2001 From: Vincent Shadbolt Date: Tue, 10 Dec 2024 16:38:02 -0800 Subject: [PATCH 10/11] updated sidebars.yaml to link to appropriate API reference --- sidebars.yaml | 24 +++++++++--------------- 1 file changed, 9 insertions(+), 15 deletions(-) diff --git a/sidebars.yaml b/sidebars.yaml index 825c1944..001b32de 100644 --- a/sidebars.yaml +++ b/sidebars.yaml @@ -59,11 +59,8 @@ - group: Tech References expanded: false pages: - - group: API Reference - expanded: false - pages: - - label: Resolution - page: openapi/resolution.page.yaml + - label: Resolution API + link: /openapi/resolution.page.yaml - label: Records reference page: resolution/records-reference.md - group: Smart Contracts @@ -109,11 +106,8 @@ - group: Tech References expanded: false pages: - - group: API Reference - expanded: false - pages: - - label: Partner API - page: openapi/partner.page.yaml + - label: Partner API + link: /openapi/partner.page.yaml - group: Smart Contracts expanded: false pages: @@ -171,15 +165,15 @@ - group: Tech References expanded: false pages: - - group: API Reference + - group: APIs expanded: false pages: - - label: Unstoppable Login API - page: openapi/loginref.page.yaml + - label: Login API + link: /openapi/loginref.page.yaml - label: Profile API - page: openapi/profile-v1.page.yaml + link: /openapi/profile-v1.page.yaml - label: Messaging API - page: openapi/messaging-v1.page.yaml + link: /openapi/messaging-v1.page.yaml - label: Error codes page: identity/api-reference/error-codes.md - group: Login Protocols From 94f7e6df6505564219035992b33640baf4981b75 Mon Sep 17 00:00:00 2001 From: Vincent Shadbolt Date: Tue, 10 Dec 2024 16:47:34 -0800 Subject: [PATCH 11/11] fix sidebars.yaml links --- sidebars.yaml | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/sidebars.yaml b/sidebars.yaml index 001b32de..4bae4817 100644 --- a/sidebars.yaml +++ b/sidebars.yaml @@ -60,7 +60,7 @@ expanded: false pages: - label: Resolution API - link: /openapi/resolution.page.yaml + link: /openapi/resolution/ - label: Records reference page: resolution/records-reference.md - group: Smart Contracts @@ -107,7 +107,7 @@ expanded: false pages: - label: Partner API - link: /openapi/partner.page.yaml + link: /openapi/partner/ - group: Smart Contracts expanded: false pages: @@ -169,11 +169,11 @@ expanded: false pages: - label: Login API - link: /openapi/loginref.page.yaml + link: /openapi/loginref/ - label: Profile API - link: /openapi/profile-v1.page.yaml + link: /openapi/profile-v1/ - label: Messaging API - link: /openapi/messaging-v1.page.yaml + link: /openapi/messaging-v1/ - label: Error codes page: identity/api-reference/error-codes.md - group: Login Protocols